StringEnumGenerator.Attributes 1.0.0-preview4

StringEnumGenerator

Source generator augumenting Enumerations.

dotnet add package StringEnumGenerator
dotnet add package StringEnumGenerator.Attributes

String enums

using StringEnumGenerator.Attributes;
public enum Food
{
    [StringEnum(Display = "Orange Carrot", Value = "orange_carrot")]
    Carrot,
    [StringEnum(Display = "Fresh Lettruce", Value = "lettruce")]
    Lettruce,
}

// Annotating enums with StringEnum lets you serialize and/or parse enums using these strings
Food.Carrot.ToDisplayString(); // returns "Orange Carrot"
Food.Carrot.ToValueString(); // returns "orange_carrot"

// You can also parse string identifiers to enum member
// FoodHelper is class automatically generated for you
FoodHelper.TryParseDisplayString("Orange Carrot", out Food food); // returns true
Food food = FoodHelper.ParseDisplayString("orange carrot", StringComparison.OrdinalIgnoreCase); // returns Food.Carrot

FoodHelper.TryParseValueString("orange_carrot", out Food food); // returns true
Food food = FoodHelper.ParseValueString("Orange_Carrot", StringComparison.OrdinalIgnoreCase); // returns Food.Carrot

Fast, enum operations without reflection or memory allocation

Just including this source genrator give following benefits for all enums

public enum Food
{
    Apples,
    Oranges,
}

Food.Apples.ToStringFast(); // faster ToString implementation which does not use reflection or allocates any memory

// FoodHelper class is generated by source generator
FoodHelper.Parse("Apples"); // faster implementation based on string without memory allocation
FoodHelper.TryParse("Apples", out Food food) // same here

// immutable array containg all members of enum, does not use reflection and allocates array on demand
// array is created in lazy manner (you pay tax only if you use it)
foreach(var food in FoodHelper.AllMembers)
{

}