FastEnum.Extensions.Generator 1.0.0-preview.3

This is a prerelease version of FastEnum.Extensions.Generator.
dotnet add package FastEnum.Extensions.Generator --version 1.0.0-preview.3
NuGet\Install-Package FastEnum.Extensions.Generator -Version 1.0.0-preview.3
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="FastEnum.Extensions.Generator" Version="1.0.0-preview.3">
  <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.
paket add FastEnum.Extensions.Generator --version 1.0.0-preview.3
#r "nuget: FastEnum.Extensions.Generator, 1.0.0-preview.3"
#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.
// Install FastEnum.Extensions.Generator as a Cake Addin
#addin nuget:?package=FastEnum.Extensions.Generator&version=1.0.0-preview.3&prerelease

// Install FastEnum.Extensions.Generator as a Cake Tool
#tool nuget:?package=FastEnum.Extensions.Generator&version=1.0.0-preview.3&prerelease

FastEnumToString

Source Generator for enums to create extension methods with basic functionality.

Usage

Use the [Extensions] on your enums, so the source generator will genrate the extensions for those enums:

Feature

  • MembersCount (field)
  • GetValues *
  • GetUnderlyingValues *
  • GetNames *
  • HasFlag *
  • IsDefined *
  • FastToString *
  • FastToString with format option *
  • GetDescription
  • TryParse (string/System.ReadOnlySpan<char>)
  • TryParseIgnoreCase (string/System.ReadOnlySpan<char>)

Note: I'm trying to make the generated code behave the same as the .NET implementation. Yet I tested most of the scenarios for the features (methods) marked with an asterisc (*) in the Features list. If you find any differences please let me know.

Limitations

  • Only actively supported .NET versions are supperted. See: supported version list
  • .NET Framwork is not supported
  • Generation extensions for enums nested in classes with generic type parameters are not supported.

Example

using FastEnum;

namespace ToStringExample;

public class NestingClass
{
    [Extensions]
    public enum NestedInClassEnum
    {
        None
    }
}

[Extensions]
public enum Color : System.Byte
{
    Red,
    Green,
    Blue,
}

[Extensions, Flags]
public enum Options
{
    None = 0,
    ToString = 1,
    Parse = 2,
    HasFlag = 4,
}
There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

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.0.0-preview.3 48 3/27/2024
1.0.0-preview.1 81 9/28/2023

First working preview version