GEnum 0.0.3

GEnum - High-Performance Enum Utility

Overview

GEnum is a library that provides extension methods to enhance the performance and usability of C# enums. Utilizing Source Generators, this library generates optimized code at compile time, offering methods that operate at speeds comparable to bitwise operations.

Installation

You can install it via NuGet:

dotnet add package GEnum

Alternatively, search for GEnum in Visual Studio's NuGet Package Manager and install it.

Features

• Bitwise Operation-Level Speed: Methods like Contains and Add utilize efficient bitwise operations.
• Convenient Extension Methods: Provides flag operations (Add, Remove, etc.), name retrieval (GetDisplayName), value checking (Is{Xxx}), and more to improve enum usability.
• Zero Allocation: All operations are performed without heap allocation, reducing GC overhead.
• Source Generator-Based: Generates all methods at compile time for high-speed execution without reflection.

Usage

using GEnum;

var flag = StatusFlag.A;

// FlagsExtensions
flag.Contains(StatusFlag.A);  // true
flag.Add(StatusFlag.B);       // flag is A | B
flag.Remove(StatusFlag.A);    // flag is B
flag.Clear();                 // flag is None

// MatchingExtensions
flag = StatusFlag.A;
flag.IsXxx();                 // Methods are generated based on the enum definition

// DisplayingExtensions
StatusFlag.None.GetDefineName();                     // "None"
StatusFlag.A.GetDefineName();                        // "A"
(StatusFlag.A | StatusFlag.B).GetDefineName();       // "Undefined"

StatusFlag.None.GetDisplayName();                    // "None"
StatusFlag.A.GetDisplayName();                       // "DisplayA"
(StatusFlag.A | StatusFlag.B).GetDisplayName();      // "DisplayA | DisplayB"

[FlagsExtensions]       // Add to use FlagsExtensions
[MatchingExtensions]    // Add to use MatchingExtensions
[DisplayingExtensions]  // Add to use DisplayingExtensions
public enum StatusFlag
{
    None = 0,
    [DisplayName("DisplayA")] A = 1 << 0,
    [DisplayName("DisplayB")] B = 1 << 1,
    C = 1 << 2,
}

Provided Methods

FlagsExtensions

MatchingExtensions

DisplayingExtensions

Benchmarks

Each function was benchmarked by executing it 100 times.

FlagsExtensions

MatchingExtensions

DisplayingExtensions