Awesome

RapidEnum

日本語版

RapidEnum is a Source Generator that provides fast-running enum utilities for C#/.NET. It is faster than the .NET API and achieves zero allocation for all methods.

Package - RapidEnum

It performed better than .NET API. It is also faster than FastEnum v1.8.0. For more information on performance comparisons, see this.

RapidEnum is heavily influenced by FastEnum. API is very similar to FastEnum. Thanks to xin9le for creating a great library!

Table of Contents

• Requirements
• Installation
  • NuGet
  • Unity
    • asmdef settings
• How to use
  • Basic usage
  • How to use it for any enum
• Performance comparison

Requirements

• .NET Standard2.0 or newer
• Unity 2022.3.12f1 or newer

Installation

NuGet

$ dotnet add package RapidEnum

nuget.org : RapidEnum

Unity

Add the following git URL from the Package Manager

https://github.com/hanachiru/RapidEnum.git?path=/RapidEnum.Unity/Packages/com.hanachiru.rapidenum

asmdef settings

If you have not created .asmdef, the following is not relevant.

If you have Override References in the .asmdef switched on, you need to add RapidEnum.Core.dll to the Assembly References.

How to use

Basic usage

Attaching [RapidEnum] to the target enum generates an enum utility class. Note that this is only valid for public or internal enum.

[RapidEnum]
public enum Weather
{
    Sun,
    Cloud,
    Rain,
    Snow
}

The Enum name + EnumExtensions class defines the relevant methods.

// Sun,Cloud,Rain,Snow
IReadOnlyList<Weather> values = WeatherEnumExtensions.GetValues();

// Sun,Cloud,Rain,Snow
IReadOnlyList<string> names = WeatherEnumExtensions.GetNames();

// Rain
string name = WeatherEnumExtensions.GetName(Weather.Rain);

// Cloud
string str = Weather.Cloud.ToStringFast();

// True
bool defined = WeatherEnumExtensions.IsDefined("Sun");

// Sun
Weather parse = WeatherEnumExtensions.Parse("Sun");

// True
// Sun
bool tryParse = WeatherEnumExtensions.TryParse("Sun", out Weather value);

How to use it for any enum

The [RapidEnumWithType] can be used to generate utility classes for any enum.

For static partial class that are public or internal, give them a [RapidEnumWithType] with the target enum as an argument. The class name can be any string, but Enum name + EnumExtensions is easier to understand.

// System.DateTimeKind has Unspecified, Utc, Local
[RapidEnumWithType(typeof(DateTimeKind))]
public static partial class DateTimeKindEnumExtensions
{
}

There is no performance difference compared to using [RapidEnum]. Use [RapidEnumWithType] if [RapidEnum] cannot be given, such as an enum provided by a third-party library.

// Unspecified,Utc,Local
IReadOnlyList<DateTimeKind> values = DateTimeKindEnumExtensions.GetValues();

// Unspecified,Utc,Local
IReadOnlyList<string> names = DateTimeKindEnumExtensions.GetNames();

// Local
string name = DateTimeKindEnumExtensions.GetName(DateTimeKind.Local);

// Local
string str = DateTimeKind.Local.ToStringFast();

// True
bool defined = DateTimeKindEnumExtensions.IsDefined("Local");

// Local
DateTimeKind parse = DateTimeKindEnumExtensions.Parse("Local");

// True
// Local
bool tryParse = DateTimeKindEnumExtensions.TryParse("Local", out DateTimeKind value);

Get Name and Value as a pair

Use the GetMembers and GetMember methods if you want to get the Name and Value of enum in pairs.

WeatherEnumExtensions.Member member = WeatherEnumExtensions.GetMember(Weather.Rain);
var (name, value) = member;

foreach (WeatherEnumExtensions.Member item in WeatherEnumExtensions.GetMembers())
{
    Console.WriteLine($"Name : {item.Name}, Value : {item.Value}");
}

Performance comparison

Benchmark Source

BenchmarkDotNet v0.14.0, macOS Sonoma 14.4.1 (23E224) [Darwin 23.4.0]
Apple M2 Pro, 1 CPU, 12 logical and 12 physical cores
.NET SDK 8.0.303
[Host]     : .NET 8.0.7 (8.0.724.31311), Arm64 RyuJIT AdvSIMD
DefaultJob : .NET 8.0.7 (8.0.724.31311), Arm64 RyuJIT AdvSIMD