Struct Cursor

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

Abstraction over a character iterator.

Implementations

impl<'a> Cursor<'a>

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

Creates a new Cursor from an input string.

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

Immutable reference to the internal character iterator.

pub fn byte_pos(&self) -> usize

The current byte position of the cursor into the input string.

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

Peeks the next character without advancing the cursor.

pub fn peek_two(&self) -> (Option<char>, Option<char>)

Peeks the next two characters without advancing the cursor.

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

Bumps the cursor and returns the next character.

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

Bumps the cursor and returns the next two characters.

pub fn skip_while(&mut self, predicate: fn(char) -> bool)

Bumps the cursor while predicate is true for the current character.

Notably, this method will not consume the first non-matching character. This is in contrast with methods like Iterator::take_while. This behavior is achieved by peeking the next character to see if it matches before consuming it.