ce.md

TaskResult Computation Expression

Namespace: FsToolkit.ErrorHandling

Examples

Example 1

The initial motivating example is perhaps more realistic if some functions are asynchronous. Given the following functions:

tryGetUser : string -> Task<User option>
isPwdValid : string -> User -> bool
authorize : User -> Task<Result<unit, AuthError>>
createAuthToken : User -> Result<AuthToken, TokenError>

A login flow can be implemented as below using the taskResult CE and a few helpers:

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

let login (username: string) (password: string) : Task<Result<AuthToken, LoginError>> =
  taskResult {
    let! user = username |> tryGetUser |> TaskResult.requireSome InvalidUser
    do! user |> isPwdValid password |> Result.requireTrue InvalidPwd
    do! user |> authorize |> TaskResult.mapError Unauthorized
    return! user |> createAuthToken |> Result.mapError TokenErr
  }

Example 2 - IAsyncEnumerable

The taskResult CE supports for .. in .. iteration over IAsyncEnumerable<'T> sequences. Iteration stops immediately when the body returns an Error, without consuming further elements.

validate : Item -> Task<Result<ValidItem, string>>
save : ValidItem -> Task<Result<unit, string>>
getItemsAsync : unit -> IAsyncEnumerable<Item>

// Task<Result<string, string>>
let processItems () =
  taskResult {
    for item in getItemsAsync () do
      let! validated = validate item
      do! save validated
    return "done"
  }
// Stops iteration immediately on the first Error

The backgroundTaskResult CE inherits this support automatically.