TaskResult (TDesu.FSharp) | TDesu.FSharp

TDesu.FSharp

TaskResult Module

Namespace: TDesu.FSharp.Tasks
Assembly: TDesu.FSharp.dll

Combinators for Task<Result<'T, 'TError>> — map, bind, tee on the inner Result.

Functions and values

Function or value	Description
`TaskResult.bind f tr` Full Usage: `TaskResult.bind f tr` Parameters: f : `'T -> Task<Result<'TResult, 'TError>>` - The binding function applied to the Ok value. tr : `Task<Result<'T, 'TError>>` - The input task containing a Result. Returns: `Task<Result<'TResult, 'TError>>` Modifiers: inline Type parameters: 'T, 'TResult, 'TError	Chains a task-returning function on `Ok` inside a `Task<Result>`. Short-circuits on `Error`. f : `'T -> Task<Result<'TResult, 'TError>>` The binding function applied to the Ok value. tr : `Task<Result<'T, 'TError>>` The input task containing a Result. Returns: `Task<Result<'TResult, 'TError>>`
`TaskResult.defaultValue def tr` Full Usage: `TaskResult.defaultValue def tr` Parameters: def : `'T` tr : `Task<Result<'T, 'a>>` Returns: `Task<'T>` Modifiers: inline Type parameters: 'T, 'a	Returns the Ok value or the given default from a Task<Result>. The default value when Error. The input task containing a Result. def : `'T` tr : `Task<Result<'T, 'a>>` Returns: `Task<'T>`
`TaskResult.ignore tr` Full Usage: `TaskResult.ignore tr` Parameters: tr : `Task<Result<'a, 'TError>>` Returns: `Task<Result<unit, 'TError>>` Modifiers: inline Type parameters: 'a, 'TError	Discards the Ok value inside a Task<Result>. The input task containing a Result. tr : `Task<Result<'a, 'TError>>` Returns: `Task<Result<unit, 'TError>>`
`TaskResult.map f tr` Full Usage: `TaskResult.map f tr` Parameters: f : `'T -> 'TResult` tr : `Task<Result<'T, 'TError>>` Returns: `Task<Result<'TResult, 'TError>>` Modifiers: inline Type parameters: 'T, 'TResult, 'TError	Maps the Ok value inside a Task<Result>. The mapping function applied to the Ok value. The input task containing a Result. f : `'T -> 'TResult` tr : `Task<Result<'T, 'TError>>` Returns: `Task<Result<'TResult, 'TError>>`
`TaskResult.mapError f tr` Full Usage: `TaskResult.mapError f tr` Parameters: f : `'TError -> 'TError2` tr : `Task<Result<'T, 'TError>>` Returns: `Task<Result<'T, 'TError2>>` Modifiers: inline Type parameters: 'TError, 'TError2, 'T	Maps the Error value inside a Task<Result>. The mapping function applied to the Error value. The input task containing a Result. f : `'TError -> 'TError2` tr : `Task<Result<'T, 'TError>>` Returns: `Task<Result<'T, 'TError2>>`
`TaskResult.tee f tr` Full Usage: `TaskResult.tee f tr` Parameters: f : `'T -> unit` tr : `Task<Result<'T, 'TError>>` Returns: `Task<Result<'T, 'TError>>` Modifiers: inline Type parameters: 'T, 'TError	Applies a side-effect on Ok inside a Task<Result> and returns unchanged. Side-effect function applied to the Ok value. The input task containing a Result. f : `'T -> unit` tr : `Task<Result<'T, 'TError>>` Returns: `Task<Result<'T, 'TError>>`
`TaskResult.teeError f tr` Full Usage: `TaskResult.teeError f tr` Parameters: f : `'TError -> unit` tr : `Task<Result<'T, 'TError>>` Returns: `Task<Result<'T, 'TError>>` Modifiers: inline Type parameters: 'TError, 'T	Applies a side-effect on Error inside a Task<Result> and returns unchanged. Side-effect function applied to the Error value. The input task containing a Result. f : `'TError -> unit` tr : `Task<Result<'T, 'TError>>` Returns: `Task<Result<'T, 'TError>>`
`TaskResult.toOption tr` Full Usage: `TaskResult.toOption tr` Parameters: tr : `Task<Result<'T, 'a>>` Returns: `Task<'T option>` Modifiers: inline Type parameters: 'T, 'a	Converts a Task<Result> to Task<Option>: Ok becomes Some, Error becomes None. The input task containing a Result. tr : `Task<Result<'T, 'a>>` Returns: `Task<'T option>`
`TaskResult.valueOr f tr` Full Usage: `TaskResult.valueOr f tr` Parameters: f : `'TError -> 'T` tr : `Task<Result<'T, 'TError>>` Returns: `Task<'T>` Modifiers: inline Type parameters: 'TError, 'T	Returns the Ok value or computes a fallback from the Error inside a Task<Result>. Function that computes a fallback from the Error value. The input task containing a Result. f : `'TError -> 'T` tr : `Task<Result<'T, 'TError>>` Returns: `Task<'T>`