Unions.Pure.Csharp 2.0.8

There is a newer version of this package available.
See the version list below for details.
dotnet add package Unions.Pure.Csharp --version 2.0.8
                    
NuGet\Install-Package Unions.Pure.Csharp -Version 2.0.8
                    
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="Unions.Pure.Csharp" Version="2.0.8" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Unions.Pure.Csharp" Version="2.0.8" />
                    
Directory.Packages.props
<PackageReference Include="Unions.Pure.Csharp" />
                    
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 Unions.Pure.Csharp --version 2.0.8
                    
#r "nuget: Unions.Pure.Csharp, 2.0.8"
                    
#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 Unions.Pure.Csharp@2.0.8
                    
#: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=Unions.Pure.Csharp&version=2.0.8
                    
Install as a Cake Addin
#tool nuget:?package=Unions.Pure.Csharp&version=2.0.8
                    
Install as a Cake Tool

C# Pure Unions

NuGet Version NuGet Downloads Build

Roslyn source generator for minimal-overhead discriminated unions. Add [UnionMember] attributes to a partial type and the generator emits a compact tag enum, factory helpers, and Match/Switch helpers without extra allocations.

Getting started

  1. Install the package in your project:
dotnet add package Unions.Pure.Csharp
  1. Annotate a partial type with the union members as properties:
using System.Text.Json.Serialization;
using Unions.Pure.Csharp;

namespace Sample;

[Union(GenerateTarget.Visitor | GenerateTarget.TryOut)]
public partial record struct PaymentStatus
{
    [JsonInclude]
    [UnionMember]
    internal string? Message { get; init; }

    [JsonInclude]
    [UnionMember]
    internal int? Code { get; init; }
}
  1. Use the generated factories and helpers:
var paid = PaymentStatus.FromCode(200);

var message = paid.Match(
    onMessage: s => $"Message: {s}",
    onCode: code => $"Code: {code}");

[Union] and [UnionMember] are injected by the generator; no manual reference is required beyond the package itself.

API choices (performance vs ergonomics)

Generated unions expose three ways to consume values:

  • GenerateTarget.IndirectLambdas: delegate-based Match / Switch (Func<> / Action<>)

    • Pros: nicest call site; familiar functional style.
    • Cons: still does delegate Invoke (typically an indirect call); capturing lambdas allocate (closures/delegates).
  • GenerateTarget.Visitor: visitor-based Match<TVisitor, TResult> / Switch<TVisitor> (generic struct visitors)

    • Pros: avoids delegate Invoke; JIT can inline; no allocations.
    • Cons: requires a small struct visitor type (can be local/private).
  • GenerateTarget.TryOut: inline IsX() / TryGetX(out ...)

    • Pros: “plain C#” if/else; no delegates; no visitors; no indirect calls.
    • Cons: more boilerplate at call site vs Match.

Note on OneOf (comparison)

OneOf is a solid library, but for hot paths it has the same core drawback as any delegate-based API: Match/Switch ultimately invoke delegates (indirect calls), and capturing lambdas allocate. It also needs to handle invalid state (cold path that throws).

Duplicate member types example

If you use the same type multiple times, provide distinct names:

using System.Text.Json.Serialization;
using Unions.Pure.Csharp;

namespace Sample;

[Union(GenerateTarget.All)]
public partial record struct DuplicateTypeUnion
{
    [JsonInclude]
    [UnionMember("String1")]
    internal string? String1 { get; init; }

    [JsonInclude]
    [UnionMember("String2")]
    internal string? String2 { get; init; }

    [JsonInclude]
    [UnionMember]
    internal int? Int32 { get; init; }
}

// Usage:
var u = DuplicateTypeUnion.FromString2("hello");
var lenOrInt = u.Match(
    onString1: s => s.Length,
    onString2: s => s.Length,
    onInt32: i => i);

GenerateTarget flags

  • GenerateTarget.None: generate nothing extra (still generates tag + factories)
  • GenerateTarget.IndirectLambdas: delegate-based Match / Switch
  • GenerateTarget.Visitor: visitor-based Match<TVisitor, TResult> / Switch<TVisitor>
  • GenerateTarget.TryOut: inline IsX() / TryGetX(out ...)
  • GenerateTarget.JsonSerialization: enable JSON serialization support (used with System.Text.Json source generation)
  • GenerateTarget.All: everything above (default when [Union] is omitted)

JSON serialization (System.Text.Json)

Unions work seamlessly with System.Text.Json source generation. Simply:

  1. Define your union with properties annotated with [JsonInclude] and [UnionMember]
  2. Add the union type to your JsonSerializerContext with [JsonSerializable(typeof(YourUnion))]
  3. Use JsonSerializer.Serialize and JsonSerializer.Deserialize with your context

The wire format is a single-property object like {"string2":"hello"} or {"int32":7}.

JSON property names

The JSON property name is derived from the property name or the [UnionMember] name:

  • If you used [UnionMember("CustomName")], the JSON property name is "CustomName" (then the context naming policy is applied when writing).
  • If you omit the custom name, the property name is used (e.g. String2 → string2 with camelCase policy).

Example:

using System.Text.Json;
using System.Text.Json.Serialization;
using Unions.Pure.Csharp;

// Union:
[Union(GenerateTarget.TryOut)]
public partial record struct SomeUnion
{
    [JsonInclude]
    [UnionMember("String1")]
    internal string? String1 { get; init; }

    [JsonInclude]
    [UnionMember("String2")]
    internal string? String2 { get; init; }

    [JsonInclude]
    [UnionMember]
    internal int? Int32 { get; init; }
}

// Context (only need to register the union type, not member types):
[JsonSourceGenerationOptions(PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase)]
[JsonSerializable(typeof(SomeUnion))]
public partial class ApiJsonContext : JsonSerializerContext;

// Use (AOT friendly, no reflection required):
var ctx = ApiJsonContext.Default;
var u = SomeUnion.FromString2("hello");
var json = JsonSerializer.Serialize(u, ctx.SomeUnion);
var back = JsonSerializer.Deserialize(json, ctx.SomeUnion);

The Tag property is automatically computed from which property is non-null, so it doesn't need to be serialized.

Swagger / OpenAPI (e.g. AOT apps)

The generator emits Swagger/OpenAPI schema registration when the project has union types and references Swashbuckle.AspNetCore. No extra define is needed: add the package and the code is generated and compiled.

  • Libraries (unions only, no Swagger): Don't reference Swashbuckle. No Swagger code is emitted, so no extra dependency.
  • App project (uses Swagger): Reference Swashbuckle and call the generated registration.
  1. Add Swashbuckle in the project that uses Swagger:

    <PackageReference Include="Swashbuckle.AspNetCore" Version="7.2.0" />
    
  2. In your Swagger setup, call the generated extension:

using Unions.Pure.Csharp;

builder.Services.AddSwaggerGen(configure =>
{
    configure.AddPureUnionsSwaggerGen();  // this assembly's union schemas
    // For union types in a referenced assembly that also references Swashbuckle:
    // PureUnionsSwaggerGen_MyContracts.AddUnionSchemaMappings(configure);

    configure.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});

Each union is mapped to an object schema with optional properties matching the union members (and their types), so the docs show the real shape instead of an empty stub.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

  • .NETStandard 2.0

    • 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
2.0.12 5,234 6/18/2026
2.0.11 168 6/18/2026
2.0.10 318 5/15/2026
2.0.9 124 5/15/2026
2.0.8 127 5/15/2026
2.0.7 126 5/15/2026
2.0.6 139 5/15/2026
2.0.5 149 2/18/2026
2.0.4 133 2/18/2026
2.0.3 2,628 1/15/2026
2.0.2 338 12/18/2025
2.0.1 315 12/18/2025
2.0.0 752 12/15/2025
1.1.0 296 12/15/2025
1.0.10 271 12/15/2025
1.0.8 259 12/14/2025
1.0.7 252 12/14/2025
1.0.6 261 12/14/2025
1.0.5 259 12/14/2025
1.0.4 256 12/14/2025