FSharp.Control.AsyncSeq


AsyncSeqSrc Module

Operations on async sequence sources.

Functions and values

Function or value Description

AsyncSeqSrc.close src

Full Usage: AsyncSeqSrc.close src

Parameters:

Closes the async sequence source casuing any created async sequences to complete.

src : AsyncSeqSrc<'T>

AsyncSeqSrc.create ()

Full Usage: AsyncSeqSrc.create ()

Parameters:
    () : unit

Returns: AsyncSeqSrc<'T>

Creates a new async sequence source.

() : unit
Returns: AsyncSeqSrc<'T>

AsyncSeqSrc.error exn src

Full Usage: AsyncSeqSrc.error exn src

Parameters:

Causes async sequence created before the call to raise an exception.

exn : exn
src : AsyncSeqSrc<'T>

AsyncSeqSrc.put item src

Full Usage: AsyncSeqSrc.put item src

Parameters:

Causes any async sequences created before the call to yield the item.

item : 'T
src : AsyncSeqSrc<'T>

AsyncSeqSrc.toAsyncSeq src

Full Usage: AsyncSeqSrc.toAsyncSeq src

Parameters:
Returns: AsyncSeq<'T>

Creates an async sequence which yields values as they are put into the source and terminates when the source is closed. This sequence will yield items starting with the next put. Many async sequences can be created from once source.

src : AsyncSeqSrc<'T>
Returns: AsyncSeq<'T>