Header menu logo XParsec

ReadableImmutableArray<'T> Type

An immutable array slice that can be read as input by the parser.

Constructors

Constructor Description

ReadableImmutableArray(arr)

Full Usage: ReadableImmutableArray(arr)

Parameters:
Returns: ReadableImmutableArray<'T>

Construct a view over the whole immutable array.

arr : ImmutableArray<'T>
Returns: ReadableImmutableArray<'T>

ReadableImmutableArray(arr, start, length)

Full Usage: ReadableImmutableArray(arr, start, length)

Parameters:
Returns: ReadableImmutableArray<'T>
arr : ImmutableArray<'T>
start : int
length : int
Returns: ReadableImmutableArray<'T>

Instance members

Instance member Description

this.AsSpan

Full Usage: this.AsSpan

Parameters:
    viewStart : int
    viewLength : int

Returns: ReadOnlySpan<'T>
viewStart : int
viewLength : int
Returns: ReadOnlySpan<'T>

this.AsSpan

Full Usage: this.AsSpan

Parameters:
    viewStart : int

Returns: ReadOnlySpan<'T>
viewStart : int
Returns: ReadOnlySpan<'T>

this.AsSpan

Full Usage: this.AsSpan

Returns: ReadOnlySpan<'T>
Returns: ReadOnlySpan<'T>

this.IsEmpty

Full Usage: this.IsEmpty

Returns: bool
Returns: bool

this[index]

Full Usage: this[index]

Parameters:
    index : int

Returns: 'T
index : int
Returns: 'T

this.Length

Full Usage: this.Length

Returns: int
Returns: int

this.Slice

Full Usage: this.Slice

Parameters:
    newStart : int
    newLength : int

Returns: ReadableImmutableArray<'T>
newStart : int
newLength : int
Returns: ReadableImmutableArray<'T>

this.ToImmutableArray

Full Usage: this.ToImmutableArray

Returns: ImmutableArray<'T>

Materialises this view into an ImmutableArray. Zero-copy when the view covers the whole backing array; otherwise allocates a fresh copy.

Returns: ImmutableArray<'T>

this.TryItem

Full Usage: this.TryItem

Parameters:
    index : int

Returns: 'T voption
index : int
Returns: 'T voption

Static members

Static member Description

ReadableImmutableArray.Empty

Full Usage: ReadableImmutableArray.Empty

Returns: ReadableImmutableArray<'T>
Returns: ReadableImmutableArray<'T>

Type something to start searching.