TomlStringEnumConverter<TEnum> Class

Definition

Namespace

Bodu.Text.Toml.Serialization

Assembly

Bodu.Text.Toml.dll

Package

Bodu.Text.Toml 1.0.0

Source

TomlStringEnumConverter{T}.cs

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

public sealed class TomlStringEnumConverter<TEnum> : TomlConverterFactory where TEnum : struct, Enum

Type Parameters

TEnum

The enumeration type the produced converter handles.

Inheritance

object

TomlConverter

TomlConverterFactory

TomlStringEnumConverter<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(TomlStringEnumConverter<Status>))]
public enum Status
{
    Active,
    OnHold,
}

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

Remarks

Unlike the non-generic TomlStringEnumConverter, 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

TomlStringEnumConverter()

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

public TomlStringEnumConverter()

TomlStringEnumConverter(NamingPolicy?, bool)

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

public TomlStringEnumConverter(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 TOML integer 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 typeToConvert; otherwise false.

CreateConverter(Type, TomlSerializerOptions)

Creates a converter for the specified type.

public override TomlConverter CreateConverter(Type typeToConvert, TomlSerializerOptions options)

Parameters

typeToConvert Type

The closed type to create a converter for.

options TomlSerializerOptions

The serializer options in effect.

Returns

TomlConverter

A converter that handles typeToConvert.

Applies to

Product	Versions
.NET	8, 10