FSharp.Control.AsyncSeq


AsyncSeq.AsyncSeqBuilder Type

Computation builder that allows creating of asynchronous sequences using the 'asyncSeq { ... }' syntax

Constructors

Constructor Description

AsyncSeqBuilder()

Full Usage: AsyncSeqBuilder()

Returns: AsyncSeqBuilder

Internal use only

Returns: AsyncSeqBuilder

Instance members

Instance member Description

this.Bind(source, body)

Full Usage: this.Bind(source, body)

Parameters:
Returns: AsyncSeq<'U>

Implements binding for the asyncSeq computation builder.

source : Async<'T>
body : 'T -> AsyncSeq<'U>
Returns: AsyncSeq<'U>

this.Combine(seq1, seq2)

Full Usage: this.Combine(seq1, seq2)

Parameters:
Returns: AsyncSeq<'T>

Implements sequential composition for the asyncSeq computation builder.

seq1 : AsyncSeq<'T>
seq2 : AsyncSeq<'T>
Returns: AsyncSeq<'T>

this.Delay(f)

Full Usage: this.Delay(f)

Parameters:
Returns: AsyncSeq<'T>

Implements delay for the asyncSeq computation builder.

f : unit -> AsyncSeq<'T>
Returns: AsyncSeq<'T>

this.For(source, action)

Full Usage: this.For(source, action)

Parameters:
Returns: AsyncSeq<'TResult>

Implements "for" loops for the asyncSeq computation builder. Asynchronous for loop - for all elements from the input sequence, generate all elements produced by the body (asynchronously). See also the AsyncSeq.collect function.

source : AsyncSeq<'T>
action : 'T -> AsyncSeq<'TResult>
Returns: AsyncSeq<'TResult>

this.For(source, action)

Full Usage: this.For(source, action)

Parameters:
    source : seq<'T>
    action : 'T -> AsyncSeq<'TResult>

Returns: AsyncSeq<'TResult>

For loop that iterates over a synchronous sequence (and generates all elements generated by the asynchronous body)

source : seq<'T>
action : 'T -> AsyncSeq<'TResult>
Returns: AsyncSeq<'TResult>

this.TryFinally(body, compensation)

Full Usage: this.TryFinally(body, compensation)

Parameters:
    body : AsyncSeq<'T>
    compensation : unit -> unit

Returns: AsyncSeq<'T>

Implements "try-finally" for the asyncSeq computation builder.

body : AsyncSeq<'T>
compensation : unit -> unit
Returns: AsyncSeq<'T>

this.TryWith(body, handler)

Full Usage: this.TryWith(body, handler)

Parameters:
Returns: AsyncSeq<'T>

Implements "try-with" for the asyncSeq computation builder.

body : AsyncSeq<'T>
handler : exn -> AsyncSeq<'T>
Returns: AsyncSeq<'T>

this.Using(resource, binder)

Full Usage: this.Using(resource, binder)

Parameters:
    resource : 'T
    binder : 'T -> AsyncSeq<'U>

Returns: AsyncSeq<'U>

Implements "use" for the asyncSeq computation builder.

resource : 'T
binder : 'T -> AsyncSeq<'U>
Returns: AsyncSeq<'U>

this.While(guard, body)

Full Usage: this.While(guard, body)

Parameters:
    guard : unit -> bool
    body : AsyncSeq<'T>

Returns: AsyncSeq<'T>

Implements "while" for the asyncSeq computation builder.

guard : unit -> bool
body : AsyncSeq<'T>
Returns: AsyncSeq<'T>

this.Yield(value)

Full Usage: this.Yield(value)

Parameters:
    value : 'T

Returns: AsyncSeq<'T>

Implements "yield" for the asyncSeq computation builder.

value : 'T
Returns: AsyncSeq<'T>

this.YieldFrom(source)

Full Usage: this.YieldFrom(source)

Parameters:
Returns: AsyncSeq<'T>

Implements "yield!" for the asyncSeq computation builder.

source : AsyncSeq<'T>
Returns: AsyncSeq<'T>

this.Zero()

Full Usage: this.Zero()

Returns: AsyncSeq<'T>

Implements empty for the asyncSeq computation builder.

Returns: AsyncSeq<'T>