Struct Lexer

pub struct Lexer { /* private fields */ }

The main component of this crate, the lexer.

Implementations

impl Lexer

pub fn new(input: &str) -> Lexer

Create a new Lexer.

pub fn with_input(self, input: &str) -> Lexer

Set the lexer’s input. Meant to be chained.

pub fn set_input(&mut self, input: &str)

Set the lexer’s input.

pub fn save_state(&self) -> State

Save the current State. To be used with Lexer::set_state.

pub fn set_state(&mut self, state: State)

Set the current State. To be paired with Lexer::save_state.

pub fn next_token(&mut self) -> Token

Lex the next token. This will return any errors met while parsing the previous token before lexing a new one.

pub fn current_char(&self) -> Option<char>

Get the current character.

pub fn next_char(&self) -> Option<char>

Get the next character.

pub fn consume(&mut self, character: char) -> bool

Move the lexer after the current character if it matches the passed one, and return if it did so.

pub fn consume_with_next(&mut self, character: char) -> bool

Like Lexer::consume but checks for the next character instead. Moves the lexer after both the current and next character.

pub fn consume_identifier(&mut self) -> SmolStr

Consume the next identifier and return it. This assumes there’s at least one character to form a valid identifier at the current position,

pub fn skip_trivia(&mut self) -> Vec<Trivia>

Get the trivia after the current position and move the lexer to after them.

pub fn skip_whitespace(&mut self) -> SmolStr

Get the whitespaces after the current positive and move the lexer to after them.

Methods from Deref<Target = State>

pub fn increment_position_by_char(&mut self, character: char)

Move the state by the passed character.

pub fn increment_position(&mut self, amount: u32)

Move th state ahead by the passed amount of characters.

pub fn lexer_position(&self) -> Position

Get the current file position.

Trait Implementations

impl Clone for Lexer

fn clone(&self) -> Lexer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Lexer

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Lexer

fn default() -> Lexer

Returns the “default value” for a type.

impl Deref for Lexer

type Target = State

The resulting type after dereferencing.

fn deref(&self) -> &<Lexer as Deref>::Target

Dereferences the value.

impl DerefMut for Lexer

fn deref_mut(&mut self) -> &mut <Lexer as Deref>::Target

Mutably dereferences the value.

impl Hash for Lexer

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Lexer

fn cmp(&self, other: &Lexer) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Lexer

fn eq(&self, other: &Lexer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Lexer

fn partial_cmp(&self, other: &Lexer) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Lexer

impl StructuralPartialEq for Lexer