FsToolkit.ErrorHandling.TaskResult 3.0.0-beta008

This is a prerelease version of FsToolkit.ErrorHandling.TaskResult.
There is a newer version of this package available.
See the version list below for details.
dotnet add package FsToolkit.ErrorHandling.TaskResult --version 3.0.0-beta008
                    
NuGet\Install-Package FsToolkit.ErrorHandling.TaskResult -Version 3.0.0-beta008
                    
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="FsToolkit.ErrorHandling.TaskResult" Version="3.0.0-beta008" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FsToolkit.ErrorHandling.TaskResult" Version="3.0.0-beta008" />
                    
Directory.Packages.props
<PackageReference Include="FsToolkit.ErrorHandling.TaskResult" />
                    
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 FsToolkit.ErrorHandling.TaskResult --version 3.0.0-beta008
                    
#r "nuget: FsToolkit.ErrorHandling.TaskResult, 3.0.0-beta008"
                    
#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 FsToolkit.ErrorHandling.TaskResult@3.0.0-beta008
                    
#: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=FsToolkit.ErrorHandling.TaskResult&version=3.0.0-beta008&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=FsToolkit.ErrorHandling.TaskResult&version=3.0.0-beta008&prerelease
                    
Install as a Cake Tool

FsToolkit.ErrorHandling

FsToolkit.ErrorHandling is a utility library to work with the Result type in F#, and allows you to do clear, simple and powerful error handling.

The library provides utility functions like map, bind, apply, traverse, sequence as well as computation expressions and infix operators to work with Result<'a, 'b>, Result<'a option, 'b>, Async<Result<'a, 'b>>, Async<Result<'a option, 'b>>, and Result<'a, 'b list>.

It was inspired by Chessie and Cvdm.ErrorHandling (the latter has now been merged into FsToolkit.ErrorHandling).

FsToolkit.ErrorHandling targets .NET Standard 2.0 and .NET Framework 4.6.1 and supports Fable.

Documentation

The documentation is available here.

Further material

Builds

GitHub Actions
GitHub Actions
Build History

NuGet

Package name Release Prelease
FsToolkit.ErrorHandling NuGet NuGet
FsToolkit.ErrorHandling.TaskResult NuGet NuGet
FsToolkit.ErrorHandling.JobResult NuGet NuGet
FsToolkit.ErrorHandling.AsyncSeq NuGet NuGet
FsToolkit.ErrorHandling.IcedTasks NuGet NuGet

Developing locally

Requirements
Compiling
> build.cmd <optional buildtarget> // on windows
$ ./build.sh  <optional buildtarget>// on unix

A motivating example

This example of composing a login flow shows one example of how this library can aid in clear, simple, and powerful error handling, using just a computation expression and a few helper functions. (The library has many more helper functions and computation expressions as well as infix operators; see the documentation for details.)

// Given the following functions:
//   tryGetUser: string -> Async<User option>
//   isPwdValid: string -> User -> bool
//   authorize: User -> Async<Result<unit, AuthError>>
//   createAuthToken: User -> Result<AuthToken, TokenError>

type LoginError = InvalidUser | InvalidPwd | Unauthorized of AuthError | TokenErr of TokenError

let login (username: string) (password: string) : Async<Result<AuthToken, LoginError>> =
  asyncResult {
    // requireSome unwraps a Some value or gives the specified error if None
    let! user = username |> tryGetUser |> AsyncResult.requireSome InvalidUser

    // requireTrue gives the specified error if false
    do! user |> isPwdValid password |> Result.requireTrue InvalidPwd

    // Error value is wrapped/transformed (Unauthorized has signature AuthError -> LoginError)
    do! user |> authorize |> AsyncResult.mapError Unauthorized

    // Same as above, but synchronous, so we use the built-in mapError
    return! user |> createAuthToken |> Result.mapError TokenErr
  }

Sponsor(s)

<a href="https://www.ajira.tech"><img src="./Ajira-logo.png" alt="Ajira Technologies, India" width="200" /></a>

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 is compatible. 
.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.

NuGet packages (6)

Showing the top 5 NuGet packages that depend on FsToolkit.ErrorHandling.TaskResult:

Package Downloads
TinyEventStore

TinyEventStore does the thing!

Migrondi.Core

This is the core library for the Migrondi CLI, you can use this library to run the same functionality of Migrondi as part of your source code or to write an abstraction for different kind of tools.

p1eXu5.FSharp.Ports.PortTaskResult

PortTaskResult computation expression.

DuxCommerce.StoreBuilder

DuxCommerce core library

FSharp.Data.GraphQL.Server.AspNetCore

FSharp implementation of Facebook GraphQL query language (Application Infrastructure)

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.18.0 367,721 10/23/2024
4.18.0-beta001 169 10/23/2024
4.17.0 133,191 9/23/2024
4.17.0-beta002 180 9/23/2024
4.17.0-beta001 178 9/23/2024
4.16.0 39,294 7/15/2024
4.15.3 4,799 7/14/2024
4.15.3-beta001 203 7/14/2024
4.15.2 172,624 5/2/2024
4.15.2-beta001 196 5/2/2024
4.15.1 91,116 1/15/2024
4.15.0 47,449 1/10/2024
4.14.0 2,954 1/2/2024
4.13.0 9,617 12/10/2023
4.13.0-beta002 889 12/10/2023
4.13.0-beta001 957 12/10/2023
4.12.0 4,635 11/27/2023
4.11.1 4,232 11/23/2023
4.11.0 15,797 11/11/2023
4.10.0 16,041 10/16/2023
4.9.0 525,588 7/10/2023
4.8.0 2,477 7/7/2023
4.7.0 9,973 6/21/2023
4.7.0-beta001 1,253 6/21/2023
4.6.0 32,404 4/20/2023
4.6.0-beta001 1,346 4/20/2023
4.5.0 9,164 3/27/2023
4.5.0-beta002 1,374 3/19/2023
4.5.0-beta001 2,152 3/6/2023
4.4.0 103,617 2/21/2023
4.3.0 15,504 1/20/2023
4.2.1 13,573 12/19/2022
4.2.0 1,886 12/17/2022
4.1.0 3,353 12/13/2022
4.1.0-beta001 1,352 12/13/2022
4.0.0 71,722 11/19/2022
4.0.0-beta001 1,253 11/19/2022
3.3.1 63,611 11/19/2022
3.3.1-beta004 1,298 11/19/2022
3.3.1-beta003 1,277 11/18/2022
3.3.1-beta002 1,348 11/18/2022
3.3.1-beta001 1,245 11/18/2022
3.3.0-beta001 1,342 11/9/2022
3.2.0 93,187 10/31/2022
3.2.0-beta001 1,249 10/31/2022
3.1.0 20,701 10/19/2022
3.0.1 2,533 10/18/2022
3.0.0 5,076 10/14/2022
3.0.0-beta008 1,340 10/14/2022
3.0.0-beta007 30,994 4/15/2022
3.0.0-beta006 1,358 4/5/2022
3.0.0-beta005 1,381 4/5/2022
3.0.0-beta004 1,437 4/5/2022
3.0.0-beta003 1,353 3/30/2022
3.0.0-beta002 1,337 2/21/2022
3.0.0-beta001 1,349 2/21/2022
2.13.0 1,369,733 1/11/2022
2.13.0-beta001 1,313 1/11/2022
2.12.0 2,420 1/6/2022
2.12.0-beta001 1,254 1/6/2022
2.11.1 18,720 12/1/2021
2.11.1-beta001 1,883 12/1/2021
2.11.0 5,236 11/24/2021
2.11.0-beta004 4,295 11/24/2021
2.11.0-beta002 4,155 11/24/2021
2.11.0-beta001 4,056 11/24/2021
2.10.0 14,835 11/13/2021
2.9.0 2,467 11/10/2021
2.9.0-beta001 1,386 11/10/2021
2.8.1 1,837 11/7/2021
2.8.0 1,697 11/7/2021
2.8.0-beta001 1,493 11/7/2021
2.7.1 3,344 10/19/2021
2.7.1-beta001 1,408 10/19/2021
2.7.0 13,805 8/2/2021
2.7.0-beta001 1,444 8/2/2021
2.6.0 4,039 7/7/2021
2.6.0-beta001 1,390 7/7/2021
2.5.0 14,394 5/26/2021
2.5.0-beta001 1,531 5/26/2021
2.4.0 1,960 5/23/2021
2.4.0-beta001 1,410 5/23/2021
2.3.0 3,530 5/14/2021
2.3.0-beta002 1,381 5/14/2021
2.2.0 11,705 4/21/2021
2.1.2 30,801 2/27/2021
2.1.1 1,774 2/26/2021
2.1.1-beta001 1,486 2/26/2021
2.1.0 1,889 2/26/2021
2.1.0-beta003 1,558 2/26/2021
2.1.0-beta002 1,504 2/25/2021
2.1.0-beta001 1,571 2/25/2021
2.0.0 649,734 11/20/2020
2.0.0-beta002 1,677 11/18/2020
2.0.0-beta001 1,773 8/29/2020
1.4.3 237,768 7/22/2020
1.4.0 5,433 6/5/2020
1.3.2 2,116 6/5/2020
1.3.1 3,065 5/29/2020
1.3.1-beta001 1,753 5/25/2020
1.3.0 4,249 5/25/2020
1.3.0-beta006 1,736 5/25/2020
1.3.0-beta005 1,813 5/25/2020
1.3.0-beta004 1,653 5/12/2020
1.2.6 25,265 2/15/2020
1.2.5 17,940 10/18/2019
1.2.4 2,172 10/10/2019
1.2.3 3,207 7/22/2019
1.2.2 2,406 5/31/2019
1.2.1 2,190 5/22/2019
1.1.1 1,886 5/9/2019
1.1.0 2,247 5/7/2019

- [Fixing stackoverflows in large while loops](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/182) Credits [@TheAngryByrd](https://github.com/TheAngryByrd)