Header menu logo fantomas

LexBuffer<'Char> Type

Input buffers consumed by lexers generated by fslex.exe. The type must be generic to match the code generated by FsLex and FsYacc (if you would like to fix this, please submit a PR to the FsLexYacc repository allowing for optional emit of a non-generic type reference).

Instance members

Instance member Description

this.BufferLocalStore

Full Usage: this.BufferLocalStore

Returns: IDictionary<string, obj>

Dynamically typed, non-lexically scoped parameter table.

Returns: IDictionary<string, obj>

this.CheckLanguageFeatureAndRecover

Full Usage: this.CheckLanguageFeatureAndRecover

Parameters:

Logs a recoverable error if a language feature is unsupported, at the specified range.

arg0 : LanguageFeature
arg1 : range

this.EndPos

Full Usage: this.EndPos

The end position for the lexeme.

this.IsPastEndOfStream

Full Usage: this.IsPastEndOfStream

True if the refill of the buffer ever failed , or if explicitly set to True.

this.LanguageVersion

Full Usage: this.LanguageVersion

Returns: LanguageVersion

Get the language version being supported

Returns: LanguageVersion

this.LexemeChar

Full Usage: this.LexemeChar

Parameters:
    arg0 : int

Returns: 'Char

Get single character of matched string

arg0 : int
Returns: 'Char

this.LexemeContains

Full Usage: this.LexemeContains

Parameters:
    arg0 : 'Char

Returns: bool

Determine if Lexeme contains a specific character

arg0 : 'Char
Returns: bool

this.LexemeView

Full Usage: this.LexemeView

Returns: ReadOnlySpan<'Char>

The currently matched text as a Span, it is only valid until the lexer is advanced

Returns: ReadOnlySpan<'Char>

this.ReportLibraryOnlyFeatures

Full Usage: this.ReportLibraryOnlyFeatures

Returns: bool

Determines if the parser can report FSharpCore library-only features.

Returns: bool

this.StartPos

Full Usage: this.StartPos

The start position for the lexeme.

this.StrictIndentation

Full Usage: this.StrictIndentation

Returns: bool option
Returns: bool option

this.SupportsFeature

Full Usage: this.SupportsFeature

Parameters:
Returns: bool

True if the specified language feature is supported.

arg0 : LanguageFeature
Returns: bool

Static members

Static member Description

LexBuffer.FromChars(reportLibraryOnlyFeatures, langVersion, strictIndentation, arg4)

Full Usage: LexBuffer.FromChars(reportLibraryOnlyFeatures, langVersion, strictIndentation, arg4)

Parameters:
    reportLibraryOnlyFeatures : bool
    langVersion : LanguageVersion
    strictIndentation : bool option
    arg3 : char[]

Returns: LexBuffer<char>

Create a lex buffer suitable for Unicode lexing that reads characters from the given array. Important: does take ownership of the array.

reportLibraryOnlyFeatures : bool
langVersion : LanguageVersion
strictIndentation : bool option
arg3 : char[]
Returns: LexBuffer<char>

LexBuffer.FromFunction(reportLibraryOnlyFeatures, langVersion, strictIndentation, arg4)

Full Usage: LexBuffer.FromFunction(reportLibraryOnlyFeatures, langVersion, strictIndentation, arg4)

Parameters:
    reportLibraryOnlyFeatures : bool
    langVersion : LanguageVersion
    strictIndentation : bool option
    arg3 : 'Char[] * int * int -> int

Returns: LexBuffer<'Char>

Create a lex buffer that reads character or byte inputs by using the given function.

reportLibraryOnlyFeatures : bool
langVersion : LanguageVersion
strictIndentation : bool option
arg3 : 'Char[] * int * int -> int
Returns: LexBuffer<'Char>

LexBuffer.FromSourceText(reportLibraryOnlyFeatures, langVersion, strictIndentation, arg4)

Full Usage: LexBuffer.FromSourceText(reportLibraryOnlyFeatures, langVersion, strictIndentation, arg4)

Parameters:
Returns: LexBuffer<char>

Create a lex buffer backed by source text.

reportLibraryOnlyFeatures : bool
langVersion : LanguageVersion
strictIndentation : bool option
arg3 : ISourceText
Returns: LexBuffer<char>

LexBuffer.LexemeString(arg1)

Full Usage: LexBuffer.LexemeString(arg1)

Parameters:
Returns: string

Fast helper to turn the matched characters into a string, avoiding an intermediate array.

arg0 : LexBuffer<char>
Returns: string

Type something to start searching.