ValueVariant 0.5.0

ValueVariant

C# source generator to generate efficient and type-safe variant types for unmanaged types.

Usage

using ValueVariant;

[ValueVariant]
public readonly partial struct SampleVariant: IValueVariant<SampleVariant, int, long, float> { }

will generates

readonly partial struct SampleVariant: IEquatable<SampleVariant>
{
    [StructLayout(LayoutKind.Explicit)]
    private struct Union
    {
        [FieldOffset(0)] int Item1;
        [FieldOffset(0)] long Item2;
        [FieldOffset(0)] float Item3;
    }

    public enum TypeIndex : byte { None, Type1, Type2, Type3 }

    private readonly Union Value;

    public readonly TypeIndex Index;

    public int Item1 => Index == TypeIndex.Type1 ? Value.Item1 : throw new InvalidCastException();
    public long Item2 => Index == TypeIndex.Type2 ? Value.Item2 : throw new InvalidCastException();
    public float Item3 => Index == TypeIndex.Type3 ? Value.Item3 : throw new InvalidCastException();

    public SampleVariant(int value) { ... }
    public SampleVariant(long value) { ... }
    public SampleVariant(float value) { ... }

    public static implicit operator SampleVariant(int value) => new SampleVariant(value);
    public static implicit operator SampleVariant(long value) => new SampleVariant(value);
    public static implicit operator SampleVariant(float value) => new SampleVariant(value);

    public static explicit operator int(SampleVariant value) => value.Item1;
    public static explicit operator long(SampleVariant value) => value.Item2;
    public static explicit operator float(SampleVariant value) => value.Item3;

    public bool Equals(SampleVariant other) { ... }
    public override bool Equals(object obj) { ... }
    public override int GetHashCode() { ... }
    public override string ToString() { ... }

    public static bool operator ==(SampleVariant lhs, SampleVariant rhs) { ... }
    public static bool operator !=(SampleVariant lhs, SampleVariant rhs) { ... }

    ...
}

Type conversion between variant types

[ValueVariant]
public readonly partial struct SampleVariant1 : IValueVariant<SampleVariant1, int, Guid, DateTime>
{
    public static explicit operator SampleVariant1(SampleVariant2 value)
        => value.Accept(SampleVariant2Converter.Instance);

    private sealed class SampleVariant2Converter : DefaultConverter<SampleVariant2Converter>, SampleVariant2.IFuncVisitor<SampleVariant1>
    {
        public SampleVariant1 Visit(in long value) => throw new InvalidCastException();
        public SampleVariant1 Visit(in bool value) => throw new InvalidCastException();
    }
}

[ValueVariant]
public readonly partial struct SampleVariant2 : IValueVariant<SampleVariant2, Guid, DateTime, int, long, bool>
{
    // implicit because SampleVariant1 ⊂ SampleVariant2
    public static implicit operator SampleVariant2(SampleVariant1 value)
        => value.Accept(SampleVariant1Converter.Instance);

    private sealed class SampleVariant1Converter : DefaultConverter<SampleVariant1Converter>, SampleVariant1.IFuncVisitor<SampleVariant2> { }
}