YamlStringEnumConverter<TEnum> Class

Definition

Namespace

Bodu.Text.Yaml.Serialization

Assembly

Bodu.Text.Yaml.dll

Package

Bodu.Text.Yaml 1.0.0

Source

YamlStringEnumConverter{T}.cs

Produces a converter that serializes the enumeration TEnum as a YAML string holding its member name, applying an optional naming policy and honoring StringEnumMemberNameAttribute on individual members.

public sealed class YamlStringEnumConverter<TEnum> : YamlConverterFactory where TEnum : struct, Enum

Type Parameters

TEnum

The enumeration type the produced converter handles.

Inheritance

object

YamlConverter

YamlConverterFactory

YamlStringEnumConverter<TEnum>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Examples

[Converter(typeof(YamlStringEnumConverter<Status>))]
public enum Status
{
    Active,
    OnHold,
}

// Status.OnHold serializes as the YAML scalar OnHold.

Remarks

Unlike the non-generic YamlStringEnumConverter, this strongly typed factory can be referenced from a ConverterAttribute on a member, property, or the enumeration itself, because it exposes a public parameterless constructor and applies to a single enumeration type.

Constructors

YamlStringEnumConverter()

Initializes a new instance of the YamlStringEnumConverter<TEnum> class that applies no naming policy and accepts integers on read.

public YamlStringEnumConverter()

YamlStringEnumConverter(NamingPolicy?, bool)

Initializes a new instance of the YamlStringEnumConverter<TEnum> class with the specified naming policy and integer-handling behavior.

public YamlStringEnumConverter(NamingPolicy? namingPolicy, bool allowIntegerValues)

Parameters

namingPolicy NamingPolicy

The naming policy applied to member names, or null to use member names unchanged.

allowIntegerValues bool

Whether a YAML integer scalar is accepted as an enumeration value on read.

Methods

CanConvert(Type)

Determines whether the converter can convert the specified type.

public override bool CanConvert(Type typeToConvert)

Parameters

typeToConvert Type

The type to test.

Returns

bool

true when the converter handles the type; otherwise false.

CreateConverter(Type, YamlSerializerOptions)

Creates a converter for the specified type.

public override YamlConverter CreateConverter(Type typeToConvert, YamlSerializerOptions options)

Parameters

typeToConvert Type

The closed type to create a converter for.

options YamlSerializerOptions

The serializer options in effect.

Returns

YamlConverter

A converter that handles typeToConvert.

Applies to

Product	Versions
.NET	8, 10