TomlStringEnumConverter Class

Definition

Namespace: Bodu.Text.Toml.Serialization

Assembly: Bodu.Text.Toml.dll

Package: Bodu.Text.Toml 1.0.0

Source: TomlStringEnumConverter.cs

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

public sealed class TomlStringEnumConverter : TomlConverterFactory

Inheritance: object

TomlConverter

TomlConverterFactory

TomlStringEnumConverter

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 TomlSerializerOptions();
options.Converters.Add(new TomlStringEnumConverter(NamingPolicy.SnakeCaseLower, allowIntegerValues: false));

// Status.OnHold now serializes as the TOML string "on_hold".

Remarks

Register the factory on Converters to apply it to every enumeration, or use the generic TomlStringEnumConverter<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.

Constructors