Struct Parser

pub struct Parser { /* private fields */ }

The main parser struct, which holds the main logic for the parser.

Implementations

impl Parser

pub fn new(stream: &str) -> Result<Self, ParseErr>

Creates a new parser from a given string.

In the instantiation process, this function will attempt to tokenize the string into tokens, raising an error if it fails.

pub fn peek(&self) -> Option<&(Token, Span)>

Peeks at the next token to read.

pub fn advance(&mut self)

Advances the parser ahead by one token.

pub fn cursor(&self) -> Span

Gets the range of the next token to read (or an EOL range if there are no more tokens to read).

pub fn parse<P: Parse>(&mut self) -> Result<P, ParseErr>

Parses the current token stream into a component, erroring if not possible.

If parsing fails, there are no guarantees about what happens to the input, and the parser likely should not be used after an error is raised during parsing.

pub fn match_<P: TokenParse>(&mut self) -> Result<Option<P>, ParseErr>

Check if the next token matches the given component and consume it if so.

This function can error if the next token does match the given component, but an error occurs in trying to convert it to that component.

pub fn advance_if<T>( &mut self, pred: impl FnOnce(Option<&Token>, Span) -> Result<T, ParseErr>, ) -> Result<T, ParseErr>

Applies the provided predicate to the next token in the input.

If an error is raised from the predicate, the parser does not advance its input.

pub fn spanned<T, E>( &mut self, f: impl FnOnce(&mut Parser) -> Result<T, E>, ) -> Result<(T, Range<usize>), E>

Calculates the span of the component created inside this region block.

pub fn is_empty(&self) -> bool

Checks whether the input for the parser is empty.