Logo Paket

AsyncExtensions Module

Extensions for async workflows.

Functions and values

Function or value Description

getCancelledException completedTask waitWithAwaiter

Full Usage: getCancelledException completedTask waitWithAwaiter

Parameters:
    completedTask : Task
    waitWithAwaiter : unit -> unit

Returns: OperationCanceledException
Modifiers: inline
completedTask : Task
waitWithAwaiter : unit -> unit
Returns: OperationCanceledException

Type extensions

Type extension Description

Async.AwaitTaskWithoutAggregate(task)

Full Usage: Async.AwaitTaskWithoutAggregate(task)

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

Extended Type: Async

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

Async.AwaitTaskWithoutAggregate(task)

Full Usage: Async.AwaitTaskWithoutAggregate(task)

Parameters:
Returns: Async<unit>

Extended Type: Async

task : Task
Returns: Async<unit>

Async.Parallel(a, b)

Full Usage: Async.Parallel(a, b)

Parameters:
Returns: Async<'a * 'b>
Type parameters: 'a, 'b

Runs both computations in parallel and returns the result as a tuple.

Extended Type: Async

a : Async<'a>
b : Async<'b>
Returns: Async<'a * 'b>

Async.StartAsTaskProperCancel(computation, ?taskCreationOptions, ?cancellationToken)

Full Usage: Async.StartAsTaskProperCancel(computation, ?taskCreationOptions, ?cancellationToken)

Parameters:
Returns: Task<'a>
Type parameters: 'a

Like StartAsTask but gives the computation time to so some regular cancellation work

Extended Type: Async

computation : Async<'a>
?taskCreationOptions : TaskCreationOptions
?cancellationToken : CancellationToken
Returns: Task<'a>

Async.StartCatchCancellation(work, ?cancellationToken)

Full Usage: Async.StartCatchCancellation(work, ?cancellationToken)

Parameters:
Returns: Async<'a>
Type parameters: 'a

Extended Type: Async

work : Async<'a>
?cancellationToken : CancellationToken
Returns: Async<'a>

Async.awaitTaskWithToken fallBack item

Full Usage: Async.awaitTaskWithToken fallBack item

Parameters:
    fallBack : unit -> 'T
    item : Task<'T>

Returns: Async<'T>
Type parameters: 'T

Extended Type: Async

fallBack : unit -> 'T
item : Task<'T>
Returns: Async<'T>

Async.map f a

Full Usage: Async.map f a

Parameters:
    f : 'a -> 'b
    a : 'a

Returns: Async<'b>
Type parameters: 'a, 'b

Extended Type: Async

f : 'a -> 'b
a : 'a
Returns: Async<'b>

Async.tryFindParallel f tasks

Full Usage: Async.tryFindParallel f tasks

Parameters:
    f : 'T -> bool
    tasks : Async<'T> seq

Returns: Async<Task<'T>[] * int option>
Type parameters: 'T

Extended Type: Async

f : 'T -> bool
tasks : Async<'T> seq
Returns: Async<Task<'T>[] * int option>

Async.tryFindSequential f tasks

Full Usage: Async.tryFindSequential f tasks

Parameters:
    f : 'T -> bool
    tasks : Async<'T> seq

Returns: Async<Task<'T> array * int option>
Type parameters: 'T

Extended Type: Async

f : 'T -> bool
tasks : Async<'T> seq
Returns: Async<Task<'T> array * int option>

Type something to start searching.