Header menu logo XParsec

Reader<'T, 'State, 'Input, 'InputSlice> Type

A cursor that tracks the current position in the input and the user state. It is used by the parser to read from the input and manage state.

Constructors

Constructor Description

Reader(input, state, index)

Full Usage: Reader(input, state, index)

Parameters:
    input : 'Input
    state : 'State
    index : int64

Returns: Reader<'T, 'State, 'Input, 'InputSlice>
input : 'Input
state : 'State
index : int64
Returns: Reader<'T, 'State, 'Input, 'InputSlice>

Instance members

Instance member Description

this.AtEnd

Full Usage: this.AtEnd

Returns: bool
Returns: bool

this.Current

Full Usage: this.Current

Returns: 'T voption
Returns: 'T voption

this.Id

Full Usage: this.Id

Returns: ReaderId
Returns: ReaderId

this.Index

Full Usage: this.Index

this.Input

Full Usage: this.Input

Returns: 'Input
Returns: 'Input

this.Length

Full Usage: this.Length

Returns: int64
Returns: int64

this.Peek

Full Usage: this.Peek

Returns: 'T voption
Returns: 'T voption

this.PeekN

Full Usage: this.PeekN

Parameters:
    count : int

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

this.Position

Full Usage: this.Position

this.Skip

Full Usage: this.Skip

this.SkipN

Full Usage: this.SkipN

Parameters:
    count : int64

count : int64

this.SkipN

Full Usage: this.SkipN

Parameters:
    count : int

count : int

this.Slice

Full Usage: this.Slice

Parameters:
    newStart : int64
    newLength : int64
    newState : 'a

Returns: Reader<'T, 'a, 'InputSlice, 'InputSlice>
newStart : int64
newLength : int64
newState : 'a
Returns: Reader<'T, 'a, 'InputSlice, 'InputSlice>

this.Slice

Full Usage: this.Slice

Parameters:
    newStart : int64
    newLength : int64

Returns: Reader<'T, unit, 'InputSlice, 'InputSlice>
newStart : int64
newLength : int64
Returns: Reader<'T, unit, 'InputSlice, 'InputSlice>

this.State

Full Usage: this.State

this.TryRead

Full Usage: this.TryRead

Returns: 'T voption
Returns: 'T voption

Type something to start searching.