FsToolkit.ErrorHandling.IcedTasks 4.1.0-beta001

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 4.1.0-beta001
                    
NuGet\Install-Package FsToolkit.ErrorHandling.IcedTasks -Version 4.1.0-beta001
                    
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="4.1.0-beta001" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FsToolkit.ErrorHandling.IcedTasks" Version="4.1.0-beta001" />
                    
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 4.1.0-beta001
                    
#r "nuget: FsToolkit.ErrorHandling.IcedTasks, 4.1.0-beta001"
                    
#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.IcedTasks@4.1.0-beta001
                    
#: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.IcedTasks&version=4.1.0-beta001&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=FsToolkit.ErrorHandling.IcedTasks&version=4.1.0-beta001&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 netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen 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 (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.1 99 12 days ago
5.0.0 304 2 months ago
5.0.0-beta014 150 2 months ago
5.0.0-beta013 149 2 months ago
5.0.0-beta012 1,266 3 months ago
5.0.0-beta011 214 4 months ago
5.0.0-beta010 124 4 months ago
5.0.0-beta009 1,344 5 months ago
5.0.0-beta008 131 5 months ago
5.0.0-beta007 287 5 months ago
5.0.0-beta006 110 5 months ago
5.0.0-beta005 124 5 months ago
5.0.0-beta004 121 6 months ago
5.0.0-beta003 114 7 months ago
5.0.0-beta002 112 7 months ago
5.0.0-beta001 120 8 months ago
4.18.0 214,268 9 months ago
4.18.0-beta001 106 9 months ago
4.17.0 251 10 months ago
4.17.0-beta002 106 10 months ago
4.17.0-beta001 105 10 months ago
4.16.0 814 7/15/2024
4.15.3 142 7/14/2024
4.15.3-beta001 119 7/14/2024
4.15.2 636 5/2/2024
4.15.2-beta001 92 5/2/2024
4.15.1 215 1/15/2024
4.15.0 151 1/10/2024
4.14.0 186 1/2/2024
4.13.0 194 12/10/2023
4.13.0-beta002 145 12/10/2023
4.13.0-beta001 137 12/10/2023
4.12.0 192 11/27/2023
4.11.1 179 11/23/2023
4.11.0 161 11/11/2023
4.10.0 181 10/16/2023
4.9.0 245 7/10/2023
4.8.0 196 7/7/2023
4.7.0 184 6/21/2023
4.7.0-beta001 167 6/21/2023
4.6.0 226 4/20/2023
4.6.0-beta001 182 4/20/2023
4.5.0 270 3/27/2023
4.5.0-beta002 192 3/19/2023
4.5.0-beta001 181 3/6/2023
4.4.0 297 2/21/2023
4.3.0 356 1/20/2023
4.2.1 409 12/19/2022
4.2.0 397 12/17/2022
4.1.0 356 12/13/2022
4.1.0-beta001 197 12/13/2022
4.0.0 402 11/19/2022
4.0.0-beta001 215 11/19/2022
3.3.1 383 11/19/2022
3.3.1-beta004 195 11/19/2022
3.3.1-beta003 192 11/18/2022
3.3.1-beta002 201 11/18/2022
3.3.1-beta001 194 11/18/2022
3.3.0-beta001 219 11/9/2022
3.2.0 421 10/31/2022
3.2.0-beta001 201 10/31/2022
3.1.0 492 10/19/2022
3.0.1 432 10/18/2022
3.0.0 484 10/14/2022
3.0.0-beta008 209 10/14/2022
3.0.0-beta007 244 4/15/2022
3.0.0-beta006 234 4/5/2022
3.0.0-beta005 232 4/5/2022
3.0.0-beta004 230 4/5/2022

- [Updates IcedTask to 0.5.0 and refactoring of Tasklike CEs](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/200) Credits @TheAngryByrd