Struct castle_input_cursor::Cursor

pub struct Cursor<R> { /* private fields */ }

Cursor over the source code.

Implementations

impl<R> Cursor<R>

pub fn pos(&self) -> Position

Gets the current position of the cursor in the source code.

pub fn next_column(&mut self)

Advances the position to the next column.

pub fn next_line(&mut self)

Advances the position to the next line.

impl<R> Cursor<R> where
    R: Read, 

pub fn new(inner: R) -> Self

Creates a new Lexer cursor.

pub fn peek(&mut self) -> Result<Option<u8>, Error>

Peeks the next byte.

pub fn peek_n(&mut self, n: u8) -> Result<u32, Error>

Peeks the next n bytes, the maximum number of peeked bytes is 4 (n <= 4).

pub fn peek_char(&mut self) -> Result<Option<u32>, Error>

Peeks the next UTF-8 character in u32 code point.

pub fn next_is(&mut self, byte: u8) -> Result<bool>

Compares the byte passed in to the next byte, if they match true is returned and the buffer is incremented

pub fn next_is_char_pred<F>(&mut self, pred: &F) -> Result<bool> where
    F: Fn(u32) -> bool, 

Applies the predicate to the next UTF-8 character and returns the result. Returns false if there is no next character, otherwise returns the result from the predicate on the ascii char

The buffer is not incremented.

pub fn next_byte(&mut self) -> Result<Option<u8>, Error>

Retrieves the next byte.

pub fn next_char(&mut self) -> Result<Option<u32>, Error>

Retrieves the next UTF-8 character.

Trait Implementations

impl<R: Debug> Debug for Cursor<R>

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

Formats the value using the given formatter.