Struct Cursor 

pub struct Cursor<'a> { /* private fields */ }

A Cursor over a string.

Based on rustc’s Cursor

Implementations

impl<'a> Cursor<'a>

pub fn new(source: &'a str) -> Self

pub fn offset(&self) -> TextSize

Retrieves the current offset of the cursor within the source code.

pub fn chars(&self) -> Chars<'a>

Return the remaining input as a string slice.

pub fn as_bytes(&self) -> &'a [u8]

Returns the remaining input as byte slice.

pub fn as_str(&self) -> &'a str

Returns the remaining input as string slice.

pub fn first(&self) -> char

Peeks the next character from the input stream without consuming it. Returns EOF_CHAR if the file is at the end of the file.

pub fn second(&self) -> char

Peeks the second character from the input stream without consuming it. Returns EOF_CHAR if the position is past the end of the file.

pub fn last(&self) -> char

Peeks the next character from the input stream without consuming it. Returns EOF_CHAR if the file is at the end of the file.

pub fn text_len(&self) -> TextSize

pub fn token_len(&self) -> TextSize

pub fn start_token(&mut self)

pub fn is_eof(&self) -> bool

Returns true if the file is at the end of the file.

pub fn bump(&mut self) -> Option<char>

Consumes the next character

pub fn bump_back(&mut self) -> Option<char>

Consumes the next character from the back

pub fn eat_char(&mut self, c: char) -> bool

pub fn eat_char2(&mut self, c1: char, c2: char) -> bool

Eats the next two characters if they are c1 and c2. Does not consume any input otherwise, even if the first character matches.

pub fn eat_char3(&mut self, c1: char, c2: char, c3: char) -> bool

Eats the next three characters if they are c1, c2 and c3 Does not consume any input otherwise, even if the first character matches.

pub fn eat_char_back(&mut self, c: char) -> bool

pub fn eat_if(&mut self, predicate: impl FnMut(char) -> bool) -> bool

Eats the next character if predicate returns true.

pub fn eat_while(&mut self, predicate: impl FnMut(char) -> bool)

Eats symbols while predicate returns true or until the end of file is reached.

pub fn eat_back_while(&mut self, predicate: impl FnMut(char) -> bool)

Eats symbols from the back while predicate returns true or until the beginning of file is reached.

pub fn skip_bytes(&mut self, count: usize)

Skips the next count bytes.

Panics

• If count is larger than the remaining bytes in the input stream.
• If count indexes into a multi-byte character.

Trait Implementations

impl<'a> Clone for Cursor<'a>

fn clone(&self) -> Cursor<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Cursor<'a>

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

Formats the value using the given formatter.