FsToolkit.ErrorHandling.AsyncSeq 3.3.0-beta001

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

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
5.1.0 93 12 days ago
5.1.0-beta001 93 12 days ago
5.0.1 353 3 months ago
5.0.0 222 4 months ago
5.0.0-beta014 157 4 months ago
5.0.0-beta013 176 4 months ago
5.0.0-beta012 676 5 months ago
5.0.0-beta011 210 6 months ago
5.0.0-beta010 144 7 months ago
5.0.0-beta009 744 7 months ago
5.0.0-beta008 141 7 months ago
5.0.0-beta007 199 8 months ago
5.0.0-beta006 141 8 months ago
5.0.0-beta005 150 8 months ago
5.0.0-beta004 157 8 months ago
5.0.0-beta003 140 9 months ago
5.0.0-beta002 134 10 months ago
5.0.0-beta001 137 12/7/2024
4.18.0 39,543 10/23/2024
4.18.0-beta001 139 10/23/2024
4.17.0 275 9/23/2024
4.17.0-beta002 109 9/23/2024
4.17.0-beta001 129 9/23/2024
4.16.0 498 7/15/2024
4.15.3 208 7/14/2024
4.15.3-beta001 140 7/14/2024
4.15.2 278 5/2/2024
4.15.2-beta001 133 5/2/2024
4.15.1 613 1/15/2024
4.15.0 42,071 1/10/2024
4.14.0 488 1/2/2024
4.13.0 273 12/10/2023
4.13.0-beta002 164 12/10/2023
4.13.0-beta001 144 12/10/2023
4.12.0 215 11/27/2023
4.11.1 207 11/23/2023
4.11.0 199 11/11/2023
4.10.0 236 10/16/2023
4.9.0 2,113 7/10/2023
4.8.0 255 7/7/2023
4.7.0 271 6/21/2023
4.7.0-beta001 213 6/21/2023
4.6.0 2,782 4/20/2023
4.6.0-beta001 197 4/20/2023
4.5.0 1,204 3/27/2023
4.5.0-beta002 201 3/19/2023
4.5.0-beta001 220 3/6/2023
4.4.0 349 2/21/2023
4.3.0 419 1/20/2023
4.2.1 403 12/19/2022
4.2.0 412 12/17/2022
4.1.0 372 12/13/2022
4.1.0-beta001 211 12/13/2022
4.0.0 489 11/19/2022
4.0.0-beta001 243 11/19/2022
3.3.1 41,387 11/19/2022
3.3.1-beta004 226 11/19/2022
3.3.1-beta003 242 11/18/2022
3.3.1-beta002 206 11/18/2022
3.3.1-beta001 230 11/18/2022
3.3.0-beta001 220 11/9/2022
3.2.0 4,622 10/31/2022
3.2.0-beta001 208 10/31/2022
3.1.0 609 10/19/2022
3.0.1 484 10/18/2022
3.0.0 560 10/14/2022
3.0.0-beta008 242 10/14/2022
3.0.0-beta007 9,263 4/15/2022
3.0.0-beta006 276 4/5/2022
3.0.0-beta005 288 4/5/2022
3.0.0-beta004 240 4/5/2022
3.0.0-beta003 265 3/30/2022
3.0.0-beta002 268 2/21/2022
3.0.0-beta001 290 2/21/2022
2.13.0 6,780 1/11/2022
2.13.0-beta001 309 1/11/2022
2.12.0 394 1/6/2022
2.12.0-beta001 292 1/6/2022
2.11.1 1,524 12/1/2021
2.11.1-beta001 885 12/1/2021
2.11.0 3,356 11/24/2021
2.11.0-beta004 3,283 11/24/2021
2.11.0-beta002 3,310 11/24/2021
2.11.0-beta001 3,202 11/24/2021

- [Updates for .NET 7](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/193). Credits @TheAngryByrd