Header menu logo FSharp.Control.TaskSeq

Task Module

Functions and values

Function or value Description

apply func

Full Usage: apply func

Parameters:
    func : 'a -> 'b

Returns: 'a -> Task<'b>
Modifiers: inline
Type parameters: 'a, 'b

Convert a plain function into a task-returning function

func : 'a -> 'b
Returns: 'a -> Task<'b>

bind binder task

Full Usage: bind binder task

Parameters:
    binder : 'T -> 'a
    task : Task<'T>

Returns: Task<'U>
Modifiers: inline
Type parameters: 'T, 'a, 'U

Bind a Task<'T>

binder : 'T -> 'a
task : Task<'T>
Returns: Task<'U>

fromResult value

Full Usage: fromResult value

Parameters:
    value : 'U

Returns: Task<'U>
Modifiers: inline
Type parameters: 'U

Creates a Task<'U> that's completed successfully with the specified result.

value : 'U
Returns: Task<'U>

ignore task

Full Usage: ignore task

Parameters:
Returns: Task
Modifiers: inline
Type parameters: 'T

Convert a Task<'T> into a non-generic Task, ignoring the result

task : Task<'T>
Returns: Task

map mapper task

Full Usage: map mapper task

Parameters:
    mapper : 'T -> 'U
    task : Task<'T>

Returns: Task<'U>
Modifiers: inline
Type parameters: 'T, 'U

Map a Task<'T>

mapper : 'T -> 'U
task : Task<'T>
Returns: Task<'U>

ofAsync async

Full Usage: ofAsync async

Parameters:
Returns: Task<'T>
Modifiers: inline
Type parameters: 'T

Starts the `Async<'T>` computation, returning the associated `Task<'T>`

async : Async<'T>
Returns: Task<'T>

ofTask task'

Full Usage: ofTask task'

Parameters:
Returns: Task<unit>
Modifiers: inline

Convert a non-generic Task into a Task

task' : Task
Returns: Task<unit>

ofValueTask valueTask

Full Usage: ofValueTask valueTask

Parameters:
Returns: Task<'T>
Modifiers: inline
Type parameters: 'T

Convert a ValueTask<'T> to a Task<'T>. For a non-generic ValueTask, consider: myValueTask |> Task.ofValueTask |> Task.ofTask.

valueTask : ValueTask<'T>
Returns: Task<'T>

toAsync task

Full Usage: toAsync task

Parameters:
Returns: Async<'T>
Modifiers: inline
Type parameters: 'T

Convert a Task<'T> into an Async<'T>

task : Task<'T>
Returns: Async<'T>

toValueTask task

Full Usage: toValueTask task

Parameters:
Returns: ValueTask<'T>
Modifiers: inline
Type parameters: 'T

Convert a Task<'T> into a ValueTask<'T>

task : Task<'T>
Returns: ValueTask<'T>

Type something to start searching.