openai/openai-dotnet

Public

mirrored from https://github.com/openai/openai-dotnetAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
OpenAI_2.0.0-beta.1

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

src/Utility/Generator/CodeGenSerializationAttribute.cs

53lines · modepreview

#nullable enable

using System;

namespace OpenAI;

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = true, Inherited = true)]
internal class CodeGenSerializationAttribute : Attribute
{
    /// <summary>
    /// Gets or sets the property name which these hooks should apply to
    /// </summary>
    public string? PropertyName { get; set; }
    /// <summary>
    /// Gets or sets the serialization path of the property in the JSON
    /// </summary>
    public string[]? SerializationPath { get; }
    /// <summary>
    /// Gets or sets the method name to use when serializing the property value (property name excluded)
    /// The signature of the serialization hook method must be or compatible with when invoking:
    /// private void SerializeHook(Utf8JsonWriter writer);
    /// </summary>
    public string? SerializationValueHook { get; set; }
    /// <summary>
    /// Gets or sets the method name to use when deserializing the property value from the JSON
    /// private static void DeserializationHook(JsonProperty property, ref TypeOfTheProperty propertyValue); // if the property is required
    /// private static void DeserializationHook(JsonProperty property, ref Optional&lt;TypeOfTheProperty&gt; propertyValue); // if the property is optional
    /// </summary>
    public string? DeserializationValueHook { get; set; }
    /// <summary>
    /// Gets or sets the method name to use when serializing the property value (property name excluded)
    /// The signature of the serialization hook method must be or compatible with when invoking:
    /// private void SerializeHook(StringBuilder builder);
    /// </summary>
    public string? BicepSerializationValueHook { get; set; }

    public CodeGenSerializationAttribute(string propertyName)
    {
        PropertyName = propertyName;
    }

    public CodeGenSerializationAttribute(string propertyName, string serializationName)
    {
        PropertyName = propertyName;
        SerializationPath = new[] { serializationName };
    }

    public CodeGenSerializationAttribute(string propertyName, string[] serializationPath)
    {
        PropertyName = propertyName;
        SerializationPath = serializationPath;
    }
}