Table of Contents

BencodeStringEnumConverter Class

Definition

Namespace
Bodu.Text.Bencode.Serialization
Assembly
Bodu.Text.Bencode.dll
Package
Bodu.Text.Bencode 1.3.0
Source
BencodeStringEnumConverter.cs

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

public sealed class BencodeStringEnumConverter : BencodeConverterFactory
Inheritance
BencodeStringEnumConverter
Inherited Members
Extension Methods

Examples

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

// Status.OnHold now serializes as the byte string 7:on_hold.

Remarks

Register the factory on Converters to apply it to every enumeration, or use the generic BencodeStringEnumConverter<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 BencodeSerializationException 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 BencodeSerializationException on a Bencode integer, and at a byte string that holds one: a byte 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 BencodeSerializationException rather than writing the decimal text it would reject on read.

Constructors

BencodeStringEnumConverter()

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

public BencodeStringEnumConverter()

BencodeStringEnumConverter(NamingPolicy?, bool)

Initializes a new instance of the BencodeStringEnumConverter class with the specified naming policy and integer-handling behavior.

public BencodeStringEnumConverter(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 Bencode integer or a byte 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, BencodeSerializerOptions)

Creates a converter for the specified type.

public override BencodeConverter CreateConverter(Type typeToConvert, BencodeSerializerOptions options)

Parameters

typeToConvert Type

The closed type to create a converter for.

options BencodeSerializerOptions

The serializer options in effect.

Returns

BencodeConverter

A converter that handles typeToConvert.

Applies to

ProductVersions
.NET8, 10