Table of Contents

TomlStringEnumConverter Class

Definition

Namespace
Bodu.Text.Toml.Serialization
Assembly
Bodu.Text.Toml.dll
Package
Bodu.Text.Toml 1.3.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
TomlStringEnumConverter
Inherited Members
Extension Methods

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. An integer accepted on read must lie within the range of the enumeration's underlying type; one outside it throws TomlSerializationException rather than being narrowed into that type.

Names are matched as System.Text.Json's JsonStringEnumConverter matches them. A member's wire name, from StringEnumMemberNameAttribute or the naming policy, binds only in its own case; the CLR name of a member the attribute does not rename also binds, in any case, while a renamed member's CLR name does not. A combination of flags is written as the comma-separated wire names of its flags, in the order ToString() lists them, and is read from a list of names in any order, with a trailing comma tolerated; an integer binds, where integers are allowed, only as the whole text.

A converter that does not allow integers throws TomlSerializationException on a TOML integer, and at a string that holds one: a string that is not a member's wire name and has an integer in any of its comma-separated parts, such as "2", " +2 " or "Read, 2", is rejected rather than bound as the integer, as System.Text.Json's JsonStringEnumConverter rejects such a string from .NET 9. The wire names are matched first, so a member named 1 through StringEnumMemberNameAttribute still reads. Such a converter also refuses to write a value that is neither a member nor a combination of defined flags, such as an undefined value or a flags value with an undefined bit, and throws TomlSerializationException rather than writing the decimal text it would reject on read.

Constructors

TomlStringEnumConverter()

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

public TomlStringEnumConverter()

TomlStringEnumConverter(NamingPolicy?, bool)

Initializes a new instance of the TomlStringEnumConverter 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 integer values are allowed: read from a TOML integer or a string that holds one, and written as the decimal text of a value that is neither a member nor a combination of flags.

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

ProductVersions
.NET8, 10