Frostware.Result 1.0.0

Frostware.Result

A simple implementation of a functional result type in C#

Table of contents

• What is a result type, and why use it
• How to use
  • Method Decleration
  • Result Handling

What is a result type, and why use it?

The result type is an alternative to a try/catch that aims to remove the need for nulls and force handling of failed cases.

By having your methods return Result, it allows you to pattern match (switch) over that result at execution. You can then supply an implementation for every possible state of your method.

How to use

This is the main result class:

public class Result
{
     // Pass inherits Result
     public static Result Pass() => new Pass(); 
     // Pass<T> inherits Pass
     public static Result Pass<T>(T value) => new Pass<T>(value); 
     
     //Fail inherits Result
     public static Result Fail(string errorMessage = "") => new Fail(errorMessage); 
     //Fail<T> inherits Fail
     public static Result Fail<T>(T value, string errorMessage = default) => new Fail<T>(value, errorMessage); 
}

A few things to note here:

• Pass can either be empty or contain a value.
• Pass<T> is a Pass, Pass is a Result. This distinction is important for pattern matching.
• Fail works the same as Pass but has an added optional error message.

Method Decleration

Simply make your method return the type "Result" and use the static helper methods on the Result class.

/// <summary>
/// Example Method
/// </summary>
/// <returns>Pass : int, Fail : int, Fail : foo</returns>
public Result ExampleMethod()
{
     if (condition1)
         return Result.Pass(20); //returns Pass<int> { Value = 20 }
     else if (condition2)
         return Result.Pass(); //returns Pass {}
     else if (condition3)
         return Result.Fail(30, "Oporation Failed"); //returns Fail<Int> { Value = 30, ErrorMessage = "Oporation Failed" }
     else if (condition4)
         return Result.Fail(new Foo()); //returns Fail<Foo> { Value = Foo {}, ErrorMessage = "" }
     else
         return Result.Fail(); //returns Fail {ErrorMessage = ""}
}

You may of noticed that we are returning both a Fail<int> and a Fail<Foo>. You can do that! Since you should be handling all possible states of your result this won't be a problem at all. Just make sure your method's summery is clear about how it works and what it may return. See the <returns /> tag for an example

Result Handling

It is recomended to pattern match over the result, either with a switch statement,

switch(ExampleMethod())
{
     case Pass<int> x:
         //triggered when result is a pass and contains a value of int
         break;
 
     case Pass<Foo> x:
         //triggered when result is a pass and contains a value of Foo
         break;
 
     case Pass _: //you can ommit the "_" as of .NET 5
         //triggered when result is a pass of any type
         break;
 
 
     case Fail<int> x:
         //triggered when result is a fail and contains a value of int
         break;
 
     case Fail<Foo> x:
         //triggered when result is a fail and contains a value of Foo
         break;
 
     case Fail _: //you can ommit the "_" as of .NET 5
         //triggered when result is a fail of any type
         break;
}

or a switch expression.

string result = ExampleMethod() switch
{
     Pass<int> x => $"This is a pass that contains the int {x.Value}",
     Pass<Foo> x => $"This is a pass that contains an instance of the class Foo {x.Value}",
     Pass => "This is an empty pass",
 
     Fail<int> x => $"This failed with message {x.ErrorMessage} and contains the int {x.Value}",
     Fail<Foo> x => $"This failed with message {x.ErrorMessage} and contains an instance of the class foo {x.Value}",
     Fail x => $"This failed with message {x.ErrorMessage}"
}

Note that if you check for Pass before Pass<int> the compiler will throw an error stating that the pattern or case has already been handled. This is do to Pass<int> being a Pass. This is intentional, it means that if you just want to check if an oporation passed and don't care about the value, you can just check for Pass. Same applies to Fail.