Moonad 1.0.2

Moonad

A simple F#'s monads port for C#.

This library contains the main F#'s monads found on FSharp.Core lib written in, and adapted for, C# on top of netstandard2.1.

Installing

The project's package can be found on Nuget and installed by your IDE or shell as following:

dotnet add package Moonad

or

PM> Install-Package Moonad

A Note on Null Reference Types

Since our main goal is to protect the user from the infamous NullReferenceException we strongly recommend the use of Nullable Reference Types on any project which uses this lib.

The Monads

F# offers in it's core library four monads to help you to have more flexibility when working with primitives and also potential null occurrences. So this library do the same.

Choice

Also known as Either in some languages this monad offers you the possibility to choose one of two types to be hold by its instance.

Example:

public Choice<int, string> Choose(bool returnInt)
{
    if(returnInt)
        return 1;

    return "This is a Choice!";
}

Result

A type to express the final state of a given operation revealing its success of failure and optionally carrying a value or an error.

Example 1 - Success indicator:

public Result Send(Message message)
{
    try
    {
       ... 
       return Result.Sucess();
    }
    catch(Exception exc)
    {
        ...
        return Result.Failure();
    }
}

Example 2 - Value bag:

public Result<User> Create(...)
{
    //When a guard clause is actioned
    return Result<User>.Failure();

    //When all is valid
    return new User(...);
}

Example 3 - Value and Error bag

public Result<User, IError> Create(...)
{
    //When a guard clause is actioned
    return new EmptyUserNameError();

    //When all is valid
    return new User(...);
}

Option

This monad, also known as Maybe, has as its goal preventing the NullReferenceException. Once a potentially null value is converted to Option it's evaluated to a Some instance, which carry the value, or a None instance, which replaces the null and let the client works as it doesn't exists.

Example 1 - Preventing null from a 3rd party lib:

//lib.Method returns a string

var option = lib.Method().ToOption();
//The ToOption method will turn a null value into a None instance.

if(option.IsSome)
    Console.WriteLine($"Returned value: {option}");
if(option.IsNone)
    Console.WriteLine($"No returned value.");

Example 2 - Creating an Option explicitly:

public Option<int> ReturnWhenGreaterThanZero(int input) =>
    input > 0 ? input : Option<int>.None;

ValueOption

It has the very same concept as Option but is intended to use with value types to be faster in performance critical scenarios.

Example 1 - Preventing null from a 3rd party lib:

//lib.Method returns a nullable int

var option = lib.Method().ToValueOption();
//The ToOption method will turn a null value into a None instance.

if(option.IsSome)
    Console.WriteLine($"Returned value: {option}");
if(option.IsNone)
    Console.WriteLine($"No returned value.");

Example 2 - Creating an Option explicitly:

public ValueOption<int> ReturnWhenGreaterThanZero(int input) =>
    input > 0 ? input : ValueOption<int>.None;

This guide is yet to be finalized

We ask for your patience while we still develop the docs about all the resources of each monad available on this lib. While waiting it's possible to check the source code and the F# docs to have an idea on how this lib works.

Thanks!