FsToolkit.ErrorHandling.IcedTasks 3.3.1-beta002

This is a prerelease version of FsToolkit.ErrorHandling.IcedTasks.
There is a newer version of this package available.
See the version list below for details.
dotnet add package FsToolkit.ErrorHandling.IcedTasks --version 3.3.1-beta002
                    
NuGet\Install-Package FsToolkit.ErrorHandling.IcedTasks -Version 3.3.1-beta002
                    
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.IcedTasks" Version="3.3.1-beta002" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FsToolkit.ErrorHandling.IcedTasks" Version="3.3.1-beta002" />
                    
Directory.Packages.props
<PackageReference Include="FsToolkit.ErrorHandling.IcedTasks" />
                    
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.IcedTasks --version 3.3.1-beta002
                    
#r "nuget: FsToolkit.ErrorHandling.IcedTasks, 3.3.1-beta002"
                    
#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.
#addin nuget:?package=FsToolkit.ErrorHandling.IcedTasks&version=3.3.1-beta002&prerelease
                    
Install FsToolkit.ErrorHandling.IcedTasks as a Cake Addin
#tool nuget:?package=FsToolkit.ErrorHandling.IcedTasks&version=3.3.1-beta002&prerelease
                    
Install FsToolkit.ErrorHandling.IcedTasks 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 net7.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on FsToolkit.ErrorHandling.IcedTasks:

Package Downloads
NBomber

Modern and flexible load testing framework for Pull and Push scenarios, designed to test any system regardless a protocol (HTTP/WebSockets/AMQP etc) or a semantic model (Pull/Push).

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
5.0.0 147 6/2/2025
5.0.0-beta014 132 6/2/2025
5.0.0-beta013 137 5/29/2025
5.0.0-beta012 855 5/1/2025
5.0.0-beta011 200 3/30/2025
5.0.0-beta010 109 3/21/2025
5.0.0-beta009 1,331 3/5/2025
5.0.0-beta008 120 3/2/2025
5.0.0-beta007 279 2/23/2025
5.0.0-beta006 99 2/21/2025
5.0.0-beta005 109 2/16/2025
5.0.0-beta004 107 2/4/2025
5.0.0-beta003 103 1/6/2025
5.0.0-beta002 101 12/21/2024
5.0.0-beta001 108 12/7/2024
4.18.0 176,004 10/23/2024
4.18.0-beta001 95 10/23/2024
4.17.0 238 9/23/2024
4.17.0-beta002 96 9/23/2024
4.17.0-beta001 94 9/23/2024
4.16.0 798 7/15/2024
4.15.3 127 7/14/2024
4.15.3-beta001 109 7/14/2024
4.15.2 625 5/2/2024
4.15.2-beta001 82 5/2/2024
4.15.1 203 1/15/2024
4.15.0 143 1/10/2024
4.14.0 175 1/2/2024
4.13.0 185 12/10/2023
4.13.0-beta002 131 12/10/2023
4.13.0-beta001 128 12/10/2023
4.12.0 178 11/27/2023
4.11.1 170 11/23/2023
4.11.0 151 11/11/2023
4.10.0 167 10/16/2023
4.9.0 217 7/10/2023
4.8.0 175 7/7/2023
4.7.0 168 6/21/2023
4.7.0-beta001 147 6/21/2023
4.6.0 211 4/20/2023
4.6.0-beta001 162 4/20/2023
4.5.0 255 3/27/2023
4.5.0-beta002 171 3/19/2023
4.5.0-beta001 157 3/6/2023
4.4.0 275 2/21/2023
4.3.0 334 1/20/2023
4.2.1 391 12/19/2022
4.2.0 381 12/17/2022
4.1.0 336 12/13/2022
4.1.0-beta001 177 12/13/2022
4.0.0 382 11/19/2022
4.0.0-beta001 194 11/19/2022
3.3.1 362 11/19/2022
3.3.1-beta004 176 11/19/2022
3.3.1-beta003 176 11/18/2022
3.3.1-beta002 177 11/18/2022
3.3.1-beta001 175 11/18/2022
3.3.0-beta001 198 11/9/2022
3.2.0 399 10/31/2022
3.2.0-beta001 182 10/31/2022
3.1.0 471 10/19/2022
3.0.1 413 10/18/2022
3.0.0 456 10/14/2022
3.0.0-beta008 189 10/14/2022
3.0.0-beta007 220 4/15/2022
3.0.0-beta006 208 4/5/2022
3.0.0-beta005 209 4/5/2022
3.0.0-beta004 205 4/5/2022

- [FSharp.Core version warning](https://github.com/demystifyfp/FsToolkit.ErrorHandling/issues/194). Credits @TheAngryByrd