StringFlagsEnumConverter Class

Definition

Namespace

Cuemon.Extensions.Text.Json.Converters

Assemblies

Cuemon.Extensions.Text.Json.dll

Source

src/Cuemon.Extensions.Text.Json/Converters/StringFlagsEnumConverter.cs

Converter to convert enums with FlagsAttribute to and from strings.

public class StringFlagsEnumConverter : JsonConverterFactory

Inheritance

object

JsonConverter

JsonConverterFactory

StringFlagsEnumConverter

Inherited Members

JsonConverterFactory.Type

Extension Methods

EnumerableExtensions.Yield<T>(T)

ObjectExtensions.Adjust<T>(T, Func<T, T>)

ObjectExtensions.Alter<T>(T, Action<T>)

ObjectExtensions.As<T, TResult>(T, Func<T, TResult>)

ObjectExtensions.IsNullable<T>(T)

ObjectExtensions.UseWrapper<T>(T, Action<IDictionary<string, object>>)

ObjectExtensions.UseWrapper<T>(T, MemberInfo, Action<IDictionary<string, object>>)

ObjectExtensions.As(object, Type, Action<ObjectFormattingOptions>)

ObjectExtensions.As<T>(object, T, Action<ObjectFormattingOptions>)

Examples

StringFlagsEnumConverter serializes and deserializes [Flags] enum values as an array of active flag string names instead of a single integer. This example registers the converter in JsonSerializerOptions, then serializes FileShare.Read | FileShare.Write which produces the JSON array ["Read", "Write"]. Deserializing the array back to a FileShare value restores the combined flags, and the output displays Read, Write, confirming round-trip correctness for flags enum values.

using System;
using System.IO;
using System.Text.Json;
using Cuemon.Extensions.Text.Json.Converters;

namespace MyApp.Examples;

public class StringFlagsEnumConverterExample
{
    public void Demonstrate()
    {
        var options = new JsonSerializerOptions
        {
            PropertyNamingPolicy = JsonNamingPolicy.CamelCase
        };
        options.Converters.Add(new StringFlagsEnumConverter());

        var value = FileShare.Read | FileShare.Write;

        string json = JsonSerializer.Serialize(value, options);
        Console.WriteLine(json);
        // ["Read", "Write"]

        var restored = JsonSerializer.Deserialize<FileShare>(json, options);
        Console.WriteLine(restored); // Read, Write

}
}

Constructors

Name	Description
StringFlagsEnumConverter()	Initializes a new instance of the StringFlagsEnumConverter class.

Methods

Name	Description
CanConvert(Type)	Determines whether the type can be converted.
CreateConverter(Type, JsonSerializerOptions)	Creates a converter for a specified typeToConvert.