NamedDiscriminatedUnions 0.0.4-alpha

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
This is a prerelease version of NamedDiscriminatedUnions.
The owner has unlisted this package. This could mean that the package is deprecated, has security vulnerabilities or shouldn't be used anymore. 
dotnet add package NamedDiscriminatedUnions --version 0.0.4-alpha
                    


                    

                
NuGet\Install-Package NamedDiscriminatedUnions -Version 0.0.4-alpha
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="NamedDiscriminatedUnions" Version="0.0.4-alpha" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="NamedDiscriminatedUnions" Version="0.0.4-alpha" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="NamedDiscriminatedUnions" />
                    


                            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 NamedDiscriminatedUnions --version 0.0.4-alpha
                    


                    

                
#r "nuget: NamedDiscriminatedUnions, 0.0.4-alpha"
#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 NamedDiscriminatedUnions@0.0.4-alpha
#: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=NamedDiscriminatedUnions&version=0.0.4-alpha&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=NamedDiscriminatedUnions&version=0.0.4-alpha&prerelease
                    


                            Install as a Cake Tool

NuGet

Getting Started

Create your union and mark it with [DiscriminatedUnion] attribute

[DiscriminatedUnion]
internal readonly partial struct MyUnion
{
    private readonly int bestNumber;
    private readonly int worstNumber;
    private readonly string? name;
    [DisallowNull]
    private readonly string[]? friends;
}

This will generate a couple kinds of methods for the struct,

  1. bool IsXYZ() and bool IsXYZ(out), which are used to test whether the union is of given type. In case of reference types marked with [DisallowNull] the out parameters will be marked with [NotNullWhen(true)].
  2. MyUnion FromXYZ(type) which are used for creating the union. In case of reference types marked with [DisallowNull] the method will throw if input is null.
  3. TMatchResult Match<TMatchResult>(Func<type1, TMatchResult>, Func<type2, TMatchResult>, ...) and void Switch(Action<type1>, Action<type2>, ...) which are used to exhaustively parse the discriminated union.

The source generator will also generate an enum for the tag, the tag field and a private constructor which are used internally for the public methods.

Usage

MyUnion result = MyUnion.FromBestNumber(7);
Print(result);
Console.WriteLine(NumberOrLength(result));
//My favourite number is 7
//7

result = MyUnion.FromWorstNumber(13);
Print(result);
Console.WriteLine(NumberOrLength(result));
//worst number = 13
//13

result = MyUnion.FromName("John");
Print(result);
Console.WriteLine(NumberOrLength(result));
//hi, my name is John
//4

result = MyUnion.FromFriends(["John", "Anny"]);
Print(result);
Console.WriteLine(NumberOrLength(result));
//John, Anny
//2

static void Print(MyUnion union)
{
    union.Switch(bestNumber => Console.WriteLine($"My favourite number is {bestNumber}"),
        worstNumber => Console.WriteLine($"worst number = {worstNumber}"),
        name => Console.WriteLine($"hi, my name is {name}"),
        friends => Console.WriteLine(string.Join(", ", friends)));
}

static int NumberOrLength(MyUnion union)
{
    return union.Match(bestNumber => bestNumber, worstNumber => worstNumber, name => name.Length, friends => friends.Length);
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in 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