YamlStringEnumConverter Class

Definition

Namespace: Bodu.Text.Yaml.Serialization

Assembly: Bodu.Text.Yaml.dll

Package: Bodu.Text.Yaml 1.0.0

Source: YamlStringEnumConverter.cs

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

public sealed class YamlStringEnumConverter : YamlConverterFactory

Inheritance: object

YamlConverter

YamlConverterFactory

YamlStringEnumConverter

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

var options = new YamlSerializerOptions();
options.Converters.Add(new YamlStringEnumConverter(NamingPolicy.SnakeCaseLower, allowIntegerValues: false));

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

Remarks

Register the factory on Converters to apply it to every enumeration, or use the generic YamlStringEnumConverter<TEnum> with ConverterAttribute to apply it to a single enumeration. Two constructors are provided: a parameterless form that applies no naming policy and accepts integers on read, and a form that takes an explicit naming policy and integer-handling flag. The produced converter writes the member name regardless of WriteEnumsAsStrings.

Constructors