UnitGenerator

You can customize the generated code by passing UnitGenerateOptions flags to the [UnitOf] attribute. This allows you to enable specific features like arithmetic operators, comparison, or serialization support.

Commonly used options include:

• ArithmeticOperator: Enables arithmetic operations between the value object and itself.
• ValueArithmeticOperator: Enables arithmetic operations between the value object and its underlying primitive type.
• Comparable: Enables comparison operators (>, <, etc.).
• MinMaxMethod: Generates Min and Max static methods.
• JsonConverter / MessagePackFormatter / DapperTypeHandler / EntityFrameworkValueConverter: Enables native serialization/persistence for the specific framework.

[UnitOf<int>(UnitGenerateOptions.ArithmeticOperator | UnitGenerateOptions.Comparable)]
public readonly partial struct Hp;

UnitGenerator uses the [UnitOf] attribute on readonly partial struct declarations to generate a type-safe Value Object. This prevents accidental assignment between different identifiers (e.g., a UserId cannot be assigned to a ProductId) while allowing you to wrap primitive types like int, Guid, or string.

For C# 11 and .NET 7 or later, you can use the generic syntax [UnitOf<T>].

using UnitGenerator;

// Using typeof syntax
[UnitOf(typeof(int))]
public readonly partial struct UserId; 

// Using generic syntax (C# 11 / .NET 7+)
[UnitOf<int>]
public readonly partial struct UserId;

When UnitGenerateOptions.Validate is enabled, the source generator adds a call to a partial void Validate() method inside the constructor. You can implement this method in your partial struct to enforce domain rules.

[UnitOf(typeof(int), UnitGenerateOptions.Validate)]
public readonly partial struct SampleValidate
{
    private partial void Validate()
    {
        if (value > 9999) throw new Exception("Invalid value range: " + value);
    }
}

UnitGenerator provides built-in support for common serialization and data access frameworks:

Dapper

Enabling UnitGenerateOptions.DapperTypeHandler generates a nested TypeHandler class. This is automatically registered at the time of Module initialization.

Entity Framework Core

Enabling UnitGenerateOptions.EntityFrameworkValueConverter generates a nested ValueConverter class. Note: This is NOT registered automatically; you must register it manually in your DbContext configuration:

builder.HasConversion(new UserId.UserIdValueConverter());

MessagePack

Enabling UnitGenerateOptions.MessagePackFormatter generates a nested IMessagePackFormatter<T> class, which is automatically used by MessagePackSerializer.

Minimum supported Unity version is 2022.3.12f1.

Option 1: NuGetForUnity (Recommended) Install UnitGenerator directly from NuGet using NuGetForUnity.

Option 2: Manual Setup

1. Download UnitGenerator.dll from the releases page.
2. Set it up as a RoslynAnalyzer in your project.

To use UnitGenerator in your C# project, install the NuGet package.

Install-Package UnitGenerator

When UnitGenerateOptions.Normalize is enabled, the source generator calls a partial void Normalize(ref T value) method during construction. This allows you to modify the underlying value during initialization (e.g., clamping values).

[UnitOf(typeof(int), UnitGenerateOptions.Normalize)]
public readonly partial struct SampleValidate
{
    private partial void Normalize(ref int value)
    {
        value = Math.Max(value, 9999);
    }
}

To avoid accidental conversion or logic errors, UnitGenerator does not generate a .Value property. Instead, use the AsPrimitive() method to retrieve the underlying value of the struct.

// If UserId is [UnitOf<int>]
int rawId = userId.AsPrimitive();

Enabling UnitGenerateOptions.Comparable implements IComparable<T> and the standard comparison operators (>, <, >=, <=).

If you want to implement IComparable<T> but not the comparison operators (for example, when using Guid where comparison might not be desired), use the UnitGenerateOptions.WithoutComparisonOperator flag alongside Comparable.

[UnitOf(typeof(Guid), UnitGenerateOptions.Comparable | UnitGenerateOptions.WithoutComparisonOperator)]
public readonly partial struct FooId { }

When the underlying type is Guid or Ulid, UnitGenerator automatically implements static New() and New***() methods (e.g., UserId.New()).

In .NET 9.0 or later, these methods accept an optional uuidV7 parameter. When set to true, they use Guid.CreateVersion7() internally.

// For a [UnitOf<Guid>] struct named GroupId
GroupId id = GroupId.New();
GroupId idV7 = GroupId.New(uuidV7: true); // .NET 9+ only