RapidEnum

August 31, 2025 · View on GitHub

English

RapidEnum は、C#/.NET 用の高速に動作する列挙型ユーティリティを提供するソースジェネレーターです。.NET 標準の APIよりも高速で、全てのメソッドでゼロアロケーションを達成しています。

Package - RapidEnum

PerformanceComparison

.NET 標準の API よりもかなりパフォーマンスが向上されています。またFastEnum v1.8.0よりも高速で動作します。パフォーマンス比較の詳細はこちらを参照してください。

RapidEnum はFastEnumに多大の影響を受けています。API は FastEnum に非常に似ています。素晴らしいライブラリを作成してくださったxin9leさんに感謝しています！

要件

.NET Standard2.0 以上
Unity 2022.3.12f1 以上

インストール

NuGet

$ dotnet add package RapidEnum

nuget.org : RapidEnum

Unity

Package Manager から下記 git URL を追加してください。

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

UPM

asmdefの設定

.asmdefを作成している場合は、Assembly Definition ReferencesにRapidEnumを追加する必要があります。

使い方

基本的な使い方

対象の列挙型に[RapidEnum]属性を付けると、列挙型ユーティリティクラスが生成されます。このときpublicかinternalの列挙型に対してのみ有効なので注意してください。

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

[RapidEnum]属性を付与した列挙型に対応する、列挙型名 + EnumExtensionsクラスに関連メソッドが定義されます。

// 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);

任意の列挙型に利用する方法

[RapidEnum]属性を列挙型に付与する以外にも、[RapidEnumWithType]属性を利用することで、任意の列挙型に対してユーティリティクラスを生成することができます。

publicかinternalであるstatic partial classに対して、引数に対象の列挙型を指定した[RapidEnumWithType]属性を付与してください。このときクラス名は任意の文字列で大丈夫ですが、列挙型名 + EnumExtensionsだと分かりやすいです。

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

[RapidEnum]を利用した場合と比べてパフォーマンスに差があるわけではありません。サードパーティ製のライブラリが提供する列挙型など、[RapidEnum]が付与できない場合は[RapidEnumWithType]を利用してください。

// 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);

Name と Value をペアで取得する

列挙型の Name と Value をペアで取得したい場合は、GetMembersメソッドやGetMemberメソッドを利用してください。

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}");
}

EnumMemberAttributeの値の取得

EnumMemberAttributeを利用している場合は、EnumMemberAttributeのValueプロパティの値を取得することができます。

[RapidEnum]
public enum Weather
{
    [EnumMember(Value = "sun")]
    Sun,
    [EnumMember]
    Cloud,
    [EnumMember(Value = "rain")]
    Rain,
    Snow
}

// sun
string enumMemberValue = Weather.Sun.GetEnumMemberValue();

// null
string enumMemberValue = Weather.Cloud.GetEnumMemberValue();

パフォーマンス比較

Method	Mean	Error	StdDev	Median	Gen0	Allocated
RapidEnum_GetValues	0.0042 ns	0.0059 ns	0.0052 ns	0.0028 ns	-	-
FastEnum_GetValues	0.0083 ns	0.0086 ns	0.0081 ns	0.0055 ns	-	-
NET_GetValues	64.4620 ns	0.9908 ns	0.9268 ns	64.2767 ns	0.0048	40 B
RapidEnum_GetNames	0.0006 ns	0.0017 ns	0.0015 ns	0.0000 ns	-	-
FastEnum_GetNames	0.0025 ns	0.0031 ns	0.0028 ns	0.0012 ns	-	-
NET_GetNames	12.3820 ns	0.1086 ns	0.1016 ns	12.4076 ns	0.0067	56 B
RapidEnum_GetName	0.0069 ns	0.0085 ns	0.0071 ns	0.0039 ns	-	-
FastEnum_GetName	0.2530 ns	0.0070 ns	0.0065 ns	0.2527 ns	-	-
NET_GetName	15.9190 ns	0.0524 ns	0.0490 ns	15.9046 ns	0.0029	24 B
RapidEnum_ToString	0.0103 ns	0.0049 ns	0.0046 ns	0.0110 ns	-	-
FastEnum_ToString	0.4844 ns	0.0062 ns	0.0052 ns	0.4845 ns	-	-
NET_ToString	6.1700 ns	0.0451 ns	0.0376 ns	6.1493 ns	0.0029	24 B
RapidEnum_IsDefines	0.0026 ns	0.0036 ns	0.0034 ns	0.0000 ns	-	-
FastEnum_IsDefines	4.6724 ns	0.0583 ns	0.0545 ns	4.6434 ns	-	-
NET_IsDefines	14.5923 ns	0.0355 ns	0.0332 ns	14.5996 ns	-	-
RapidEnum_Parse	0.9258 ns	0.0161 ns	0.0150 ns	0.9240 ns	-	-
FastEnum_Parse	4.6223 ns	0.0082 ns	0.0073 ns	4.6192 ns	-	-
NET_Parse	8.8707 ns	0.0965 ns	0.0903 ns	8.8293 ns	-	-
RapidEnum_TryParse	0.7633 ns	0.0097 ns	0.0090 ns	0.7657 ns	-	-
FastEnum_TryParse	4.6869 ns	0.0254 ns	0.0212 ns	4.6852 ns	-	-
NET_TryParse	8.8433 ns	0.0609 ns	0.0569 ns	8.8268 ns	-	-