Header menu logo fantomas

Cancellable Module

Functions and values

Function or value Description

fold f acc seq

Full Usage: fold f acc seq

Parameters:
    f : 'State -> 'T -> Cancellable<'State>
    acc : 'State
    seq : 'T seq

Returns: Cancellable<'State>
f : 'State -> 'T -> Cancellable<'State>
acc : 'State
seq : 'T seq
Returns: Cancellable<'State>

run ct arg2

Full Usage: run ct arg2

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

Run a cancellable computation using the given cancellation token

ct : CancellationToken
arg1 : Cancellable<'T>
Returns: ValueOrCancelled<'T>

runWithoutCancellation comp

Full Usage: runWithoutCancellation comp

Parameters:
Returns: 'T

Run the computation in a mode where it may not be cancelled. The computation never results in a ValueOrCancelled.Cancelled.

comp : Cancellable<'T>
Returns: 'T

toAsync arg1

Full Usage: toAsync arg1

Parameters:
Returns: Async<'T>
arg0 : Cancellable<'T>
Returns: Async<'T>

token ()

Full Usage: token ()

Parameters:
    () : unit

Returns: Cancellable<CancellationToken>

Bind the cancellation token associated with the computation

() : unit
Returns: Cancellable<CancellationToken>

Type something to start searching.