Struct GeneratorTokenQueue

pub struct GeneratorTokenQueue<T, TData, TGeneratorState, TGenerator>
where
    T: TokenTrait,
    for<'a> TGenerator: FnMut(&mut TGeneratorState, &mut GeneratorTokenQueueBuffer<'a, T, TData>),
{ /* private fields */ }

A token queue which has a backing generator/lexer which is called when needed by parsing logic

Implementations

impl<T, TData, TGeneratorState, TGenerator> GeneratorTokenQueue<T, TData, TGeneratorState, TGenerator>

where T: TokenTrait, for<'a> TGenerator: FnMut(&mut TGeneratorState, &mut GeneratorTokenQueueBuffer<'a, T, TData>),

pub fn new(generator: TGenerator, generator_state: TGeneratorState) -> Self

Create a new GeneratorTokenQueue with a lexer function and initial state

Trait Implementations

impl<T, TData, TGeneratorState, TGenerator> TokenReader<T, TData> for GeneratorTokenQueue<T, TData, TGeneratorState, TGenerator>

where T: TokenTrait, TData: Debug, for<'a> TGenerator: FnMut(&mut TGeneratorState, &mut GeneratorTokenQueueBuffer<'a, T, TData>),

fn peek(&mut self) -> Option<&Token<T, TData>>

Returns a reference to next token but does not advance current position

fn peek_n(&mut self, n: usize) -> Option<&Token<T, TData>>

Returns a reference to nth (zero based) upcoming token without advancing

fn next(&mut self) -> Option<Token<T, TData>>

Returns the next token and advances

fn scan( &mut self, cb: impl FnMut(&T, &TData) -> bool, ) -> Option<&Token<T, TData>>

Runs the closure (cb) over upcoming tokens. Passes the value behind the Token to the closure. Will stop and return a reference to the next Token from when the closure returns true. Returns None if scanning finishes before closure returns true. Does not advance the reader.

fn peek_mut(&mut self) -> Option<&mut Token<T, TData>>

Use with caution

fn conditional_next( &mut self, cb: impl FnOnce(&T) -> bool, ) -> Option<Token<T, TData>>

Returns next if cb returns true for the upcoming token (the token from TokenReader::peek)

fn expect_next( &mut self, expected_type: T, ) -> Result<TData, Option<(T, Token<T, TData>)>>

Tests that next token matches an expected type. Will return error if does not match. The Ok value contains the data of the valid token. Else it will return the Err with the expected token type and the token that did not match