ResultType 2.0.0

dotnet add package ResultType --version 2.0.0
                    
NuGet\Install-Package ResultType -Version 2.0.0
                    
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="ResultType" Version="2.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ResultType" Version="2.0.0" />
                    
Directory.Packages.props
<PackageReference Include="ResultType" />
                    
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 ResultType --version 2.0.0
                    
#r "nuget: ResultType, 2.0.0"
                    
#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 ResultType@2.0.0
                    
#: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=ResultType&version=2.0.0
                    
Install as a Cake Addin
#tool nuget:?package=ResultType&version=2.0.0
                    
Install as a Cake Tool

NuGet License

Build server Build status
Travis Build Status

ResultType is an implementation of Result type for C#.

This library offers an elegant and efficient way of handling errors known as railway programming. Result object holds the desired value or error message. Thanks to that, ResultType allows you to deal with errors without resorting to using exceptions. It's really easy to use and can be used alongside exceptions in order to build a system where expected errors are handled using ResultType and unexpected errors are thrown as exceptions.

How it works?

The library contains two types that implement Result<T> abstract class - Success and Error.

Getting started

The basic feature of ResultType is holding value or error. Let's look at an examples:

var result = ResultFactory.CreateSuccess(value);

Example of an error:

var result = ResultFactory.CreateError("error message");

It's possible to create Success without value:

var result = ResultFactory.CreateSuccess(value);

In this case value of type Nothing is stored. To unpack value you have to call GetValue() method:

var unpackedValue = result.GetValue();

Unpacking error is simillar:

var upackedValue = result.GetError();

If you call GetValue() method on Error or GetError on Success, InvalidOperationException will be thrown.

It is really easy to check if result is success:

var isSucces = result.IsSuccess();

or error:

var isSucces = result.IsError();

You can chain functions that returns Result type using cotinuations:

public Result<Nothing> SomeFunction(Result<Nothing> result)
{
    return result.Continue(() => ResultFactory.CreateSuccess());
}

When you call Continue() method, it checks if the result is Success or Error. If it is Success then provided lambda expresion is executed. In other case error message is propagated.

It's possible to pass value from previous expresion as argument.

public Result<string> SomeFunction(Result<Nothing> result)
{
    return result.Continue(s => ResultFactory.CreateSuccess(s));
}

Tasks thar returns Result can also be chained using Continue method.

public async Task<Result<string>> SomeFunction(Result<Nothing> result)
{
    return await result.Continue(s => ResultFactory.CreateSuccess(s));
}
public async Task<Result<string>> SomeFunction(Result<Nothing> result)
{
    return await result.Continue(async s => await SomeAsyncFunction(s));
}
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 is compatible.  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.
  • .NETCoreApp 2.2

    • No dependencies.
  • .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
2.0.0 945 4/1/2019
1.0.1 1,099 2/10/2019
1.0.0 1,208 6/2/2018