AeonSake.Extensions.Enums 1.2.0

Enum Extensions

This library contains a small collection of extension methods for enums. Also contains an optional source-generator for faster extension calls.

Installation

The library is available as NuGet package on nuget.org and this project's GitLab Package Registry.

Features

Wrapper/Polyfill Methods

The library provides generic wrappers and polyfill implementations for several Enum class methods, usable directly on the type or instance.

using AeonSake.Extensions.Enums;

public enum MyEnum
{
    Value1 = 1,
    Value2 = 2
}

MyEnum.GetValues(); //returns [MyEnum.Value1, MyEnum.Value2]
MyEnum.GetNames();   //returns ["Value1", "Value2"]

MyEnum.Value1.IsDefined(); //returns true
((MyEnum) 99).IsDefined(); //returns false

MyEnum.Value1.GetName(); //returns "Value1"

Flag Methods

The library also contains several extension methods to improve the handling of flagged enums.

using AeonSake.Extensions.Enums;

[Flags]
public enum MyEnum
{
    Value0 = 0,
    Value1 = 1,
    Value2 = 2,
    Value3 = 4,
    Value2And3 = Value2 | Value3
}

MyEnum.GetFlagValues(); //returns [MyEnum.Value1, MyEnum.Value2, MyEnum.Value3]

(MyEnum.Value1|MyEnum.Value2).GetFlags(); //returns [MyEnum.Value1, MyEnum.Value2]
MyEnum.Value2And3.GetFlags();             //returns [MyEnum.Value2, MyEnum.Value3]
((MyEnum) 5).GetFlags();                  //returns [MyEnum.Value1, MyEnum.Value3]

Other Methods

using System.ComponentModel.DataAnnotations;
using AeonSake.Extensions.Enums;

public enum MyEnum
{
    [Display(Name = "Value 1")]
    Value1 = 1,
    Value2 = 2
}

MyEnum.Value1.ToValue(); //returns 1 (as ulong)

MyEnum.Value1.GetDisplayName(); //returns "Value 1"
MyEnum.Value2.GetDisplayName(); //returns "Value2"
((MyEnum) 99).GetDisplayName(); //returns "99"

Source-Generator

The library also includes a source-generator to pre-compile the content of all mentioned extension methods. This drastically improves speed, decreases memory allocation, and avoids any use of reflection. The cost is the additional generated code alongside your enum type definitions. Just apply the GeneratedEnumExtensionsAttribute to the enum type you wish to pre-compile. The source-generator will also recognize, if an enum has FlagsAttribute set and generates extension methods for flagged enums accordingly.

[GeneratedEnumExtensions]
public enum MyEnum
{
    Value1 = 1,
    Value2 = 2
}

Source-generated extension methods come with a few limitations:

• Enum types must be public or internal
• If the enum type is nested in another class, the overall accessibility to the enum type must still be public or internal (i.e., the container class cannot be less accessible than that)
• Enum types cannot be nested in a generic class

Benchmarks

BenchmarkDotNet v0.15.8, Windows 10 (10.0.19045.6466/22H2/2022Update)
Intel Core i7-9700K CPU 3.60GHz (Coffee Lake), 1 CPU, 8 logical and 8 physical cores
.NET SDK 10.0.203
  [Host]     : .NET 10.0.7 (10.0.7, 10.0.726.21808), X64 RyuJIT x86-64-v3
  DefaultJob : .NET 10.0.7 (10.0.7, 10.0.726.21808), X64 RyuJIT x86-64-v3

Building from Source

Building this project requires .NET 5.0 SDK or newer, or .NET Core 3.0 or newer. Refer to the full list of supported frameworks to see more.
Some packages are loaded from external sources (nuget.org) and are required for compilation. Make sure to run nuget restore (or Restore NuGet packages from inside Visual Studio) before building.

License

The project is licensed under MIT.