Skip to content

Latest commit

 

History

History
127 lines (93 loc) · 3.78 KB

README.md

File metadata and controls

127 lines (93 loc) · 3.78 KB
Raw

Enumify.Net

A lightweight type safety library for enum type values and description.

Nuget

Install Enumify.Net via Nuget

PM> Install-Package Enumify.Net

Platform Support

  • netstandard 2.1, netstandard 2.0
  • netcoreapp 3.1, netcoreapp 3.0, netcoreapp 2.2, netcoreapp 2.1, netcoreapp 2.0,
  • NetFramework 4.8.0

API usage

Convert a string value to enum type.

DayOfWeek saturday = Enums.Parse<DayOfWeek>("Saturday");

Get Values

IList<DayOfWeek> values = Enums.GetValues<DayOfWeek>();

Get Names

IList<string> names = Enums.GetNames<DayOfWeek>();

Get Name

string name = DayOfWeek.Saturday.GetName();

Parses an enum from a string.

bool result = Enums.TryParse("Saturday", out DayOfWeek day);


Assert.True(Enums.TryParse("One", out Number number));
Assert.Equal(Number.One, number);

Assert.False(Enums.TryParse("1", out number));
Assert.Equal((Number)0, number);

Assert.False(Enums.TryParse("foo", out number));
Assert.Equal((Number)0, number);

Returns boolean whether a specified enum name exist in the given enum type.

bool isDefinedAsString = Enums.IsDefined<Number>("One");
bool isDefinedAsInt = Enums.IsDefined<Number>(1);
bool isDefinedAsLong = Enums.IsDefined<Int64Enum>(0x7FFFFFFFFFFFFFFF);
bool isDefinedAsByte = Enums.IsDefined<ByteEnum>(1);

Get Enum Description

string desc = Number.One.GetDescription();

Parse Enum Description.

bool result = Enums.TryParseDescription("Third description", out Number number);
 

public enum Number
{
    [EnumDescription("First description")]
    One = 1,
    
    Two = 2,
    
    [EnumDescription("Third description")]
    Three = 3
}

 [Flags]
 public enum Int64Enum : long
 {
     MinusOne = -1,
     Zero = 0,
     Max = 0x7FFFFFFFFFFFFFFF
 }

Get underlying type.

Assert.Equal(typeof(byte), Enums.GetUnderlyingType<ByteEnum>());
Assert.Equal(typeof(int), Enums.GetUnderlyingType<Number>());
Assert.Equal(typeof(long), Enums.GetUnderlyingType<Int64Enum>());
Assert.Equal(typeof(ulong), Enums.GetUnderlyingType<UInt64Enum>());

Benchmark

Thanks to Benchmark DotNet library.

Get Values

Method Mean Error StdDev Rank Gen 0 Gen 1 Gen 2 Allocated
EnumifyDotNet 0.0000 ns 0.0000 ns 0.0000 ns 1 - - - -
DotNet 855.3133 ns 16.9984 ns 42.0158 ns 2 0.0534 - - 224 B

Get Names

Method Mean Error StdDev Median Rank Gen 0 Gen 1 Gen 2 Allocated
EnumifyDotNet 0.4590 ns 0.2194 ns 0.6468 ns 0.0000 ns 1 - - - -
DotNet 57.0122 ns 2.0174 ns 5.7884 ns 56.0215 ns 2 0.0191 - - 80 B

Parse String

Method Mean Error StdDev Median Rank Gen 0 Gen 1 Gen 2 Allocated
Enumify 89.66 ns 1.873 ns 4.766 ns 89.68 ns 1 - - - -
DotNet 110.80 ns 14.266 ns 42.062 ns 85.87 ns 1 - - - -

Please check out more samples in the Unit test app.