NonAllocFlagGenerator 1.3.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package NonAllocFlagGenerator --version 1.3.1
                    
NuGet\Install-Package NonAllocFlagGenerator -Version 1.3.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NonAllocFlagGenerator" Version="1.3.1">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="NonAllocFlagGenerator" Version="1.3.1" />
                    
Directory.Packages.props
<PackageReference Include="NonAllocFlagGenerator">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add NonAllocFlagGenerator --version 1.3.1
                    
#r "nuget: NonAllocFlagGenerator, 1.3.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package NonAllocFlagGenerator@1.3.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=NonAllocFlagGenerator&version=1.3.1
                    
Install as a Cake Addin
#tool nuget:?package=NonAllocFlagGenerator&version=1.3.1
                    
Install as a Cake Tool

NonAllocFlagGenerator

An efficient solution for flag checking in C# and Unity

Benefits of NonAllocFlagGenerator

  • Solves the boxing issue of the default HasFlag method
  • Improves performance by minimizing garbage generation
  • Easy to use

Installation

  1. Open the Package Manager in Unity (Window > Package Manager)
  2. Add the NonAllocFlagGenerator package using the following Git URL:
    https://github.com/KBluePurple/NonAllocFlagGenerator.git?path=/Plugins#master

How It Works

NonAllocFlagGenerator uses C# Source Generators to automatically generate efficient extension methods for enums marked with the [Flags] attribute. Here's a detailed breakdown of the process:

  1. Source Generation: At compile time, the generator scans your codebase for any enum types decorated with the [Flags] attribute.

  2. Extension Method Creation: For each flagged enum it finds, the generator automatically creates specialized extension methods that perform flag checking operations without allocating memory on the heap.

  3. Compile-Time Processing: All the code generation happens during compilation, which means:

    • There's no runtime overhead for generating the methods
    • The generated code is type-safe and checked by the compiler
    • You get IDE support like IntelliSense for the generated methods
  4. Zero Allocation Design: The generated extension methods use bitwise operations instead of boxing/unboxing, ensuring that no garbage is generated during flag checks.

Usage Example

[Flags]
public enum PlayerState
{
   None = 0,
   Idle = 1 << 0,
   Walking = 1 << 1,
   Running = 1 << 2,
   Jumping = 1 << 3,
   All = ~0
}
var currentState = PlayerState.Idle | PlayerState.Walking;
// Efficient flag checking using NonAllocFlagGenerator
if (currentState.HasFlagNonAlloc(PlayerState.Idle))
{
    // Handle Idle state
}
if (currentState.HasFlagNonAlloc(PlayerState.Walking))
{
    // Handle Walking state
}

With NonAllocFlagGenerator, you can easily check flags while writing readable code without compromising performance. Apply NonAllocFlagGenerator to your project today and experience efficient flag checking!

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.4.0 190 11/25/2025
1.3.1 219 3/17/2025