FSharp.Collections.Immutable 1.0.0

Edit this page

FlatListCE Type

Namespace: FSharp.Collections.Immutable
Assembly: FSharp.Collections.Immutable.dll
Base Type: obj

The builder of the flatList { } computation expression.

The expression collects its elements in an Builder and returns them without a copy when the builder is full (ADR 0001, D7).

Constructors

Constructor Description

FlatListCE()

Full Usage: FlatListCE()

Returns: FlatListCE

Creates the builder of the expression.

Returns: FlatListCE

Instance members

Instance member Description

this.Combine

Full Usage: this.Combine

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

Adds the elements of two parts of the expression, in order.

first : FlatListBuffer<'T>
second : FlatListBuffer<'T>
Returns: FlatListBuffer<'T>

this.Delay

Full Usage: this.Delay

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

Runs the body of the expression each time the elements are collected.

delayed : unit -> FlatListBuffer<'T>
Returns: FlatListBuffer<'T>

this.For

Full Usage: this.For

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

Adds the elements of the body for each item of a sequence.

source : 'U seq
body : 'U -> FlatListBuffer<'T>
Returns: FlatListBuffer<'T>
ArgumentNullException Thrown when the sequence is or a default flat list.

this.Run

Full Usage: this.Run

Parameters:
Returns: FlatList<'T>

Collects the elements of the expression.

buffer : FlatListBuffer<'T>
Returns: FlatList<'T>

this.TryFinally

Full Usage: this.TryFinally

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

Runs the compensation after the body.

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

this.TryWith

Full Usage: this.TryWith

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

Handles the exceptions of the body.

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

this.Using

Full Usage: this.Using

Parameters:
Returns: FlatListBuffer<'T>
Modifiers: inline
Type parameters: 'Resource, 'T

Disposes a resource after the body.

resource : 'Resource
body : 'Resource -> FlatListBuffer<'T>
Returns: FlatListBuffer<'T>

this.While

Full Usage: this.While

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

Adds the elements of the body while the guard holds.

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

this.Yield

Full Usage: this.Yield

Parameters:
    item : 'T

Returns: FlatListBuffer<'T>
Modifiers: inline
Type parameters: 'T

Adds an element.

item : 'T
Returns: FlatListBuffer<'T>

this.YieldFrom

Full Usage: this.YieldFrom

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

Adds the elements of another expression body.

buffer : FlatListBuffer<'T>
Returns: FlatListBuffer<'T>

this.YieldFrom

Full Usage: this.YieldFrom

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

Adds the elements of a flat list.

items : FlatList<'T>
Returns: FlatListBuffer<'T>
ArgumentNullException Thrown when the flat list is a default flat list.

this.YieldFrom

Full Usage: this.YieldFrom

Parameters:
    items : 'T array

Returns: FlatListBuffer<'T>
Modifiers: inline
Type parameters: 'T

Adds the elements of an array.

items : 'T array
Returns: FlatListBuffer<'T>
ArgumentNullException Thrown when the array is .

this.YieldFrom

Full Usage: this.YieldFrom

Parameters:
    items : 'T seq

Returns: FlatListBuffer<'T>
Modifiers: inline
Type parameters: 'T

Adds the elements of a sequence.

items : 'T seq
Returns: FlatListBuffer<'T>
ArgumentNullException Thrown when the sequence is or a default flat list.

this.Zero

Full Usage: this.Zero

Returns: FlatListBuffer<'T>
Modifiers: inline
Type parameters: 'T

An expression without elements.

Returns: FlatListBuffer<'T>