Class ExtensibleEnumConverterFactory

Namespace

Cloudflare.NET.Core.Json

Assembly

Cloudflare.NET.dll

A JSON converter factory that automatically creates converters for any type implementing IExtensibleEnum<TSelf>.

Register this factory with Converters to enable automatic serialization of all extensible enum types without individual converter attributes.

public class ExtensibleEnumConverterFactory : JsonConverterFactory

Inheritance

object

JsonConverter

JsonConverterFactory

ExtensibleEnumConverterFactory

Inherited Members

JsonConverterFactory.Type

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Examples

var options = new JsonSerializerOptions();
options.Converters.Add(new ExtensibleEnumConverterFactory());

Remarks

This factory uses reflection to detect types implementing the extensible enum interface and creates the appropriate generic converter instance.

Methods

CanConvert(Type)

When overridden in a derived class, determines whether the converter instance can convert the specified object type.

public override bool CanConvert(Type typeToConvert)

Parameters

typeToConvert Type

The type of the object to check whether it can be converted by this converter instance.

Returns

bool

true if the instance can convert the specified object type; otherwise, false.

CreateConverter(Type, JsonSerializerOptions)

Creates a converter for a specified type.

public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options)

Parameters

typeToConvert Type

The type handled by the converter.

options JsonSerializerOptions

The serialization options to use.

Returns

JsonConverter

A converter for which T is compatible with typeToConvert.