Struct Cursor 

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

Peekable iterator over a char sequence.

Next characters can be peeked via first method, and position can be shifted forward via bump method.

Implementations

impl<'a> Cursor<'a>

pub fn new( input: &'a str, frontmatter_allowed: FrontmatterAllowed, ) -> Cursor<'a>

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

pub fn first(&self) -> char

Peeks the next symbol from the input stream without consuming it. If requested position doesn’t exist, EOF_CHAR is returned. However, getting EOF_CHAR doesn’t always mean actual end of file, it should be checked with is_eof method.

pub fn third(&self) -> char

Peeks the third symbol from the input stream without consuming it.

impl Cursor<'_>

pub fn advance_token(&mut self) -> Token

Parses a token from the input string.

pub fn guarded_double_quoted_string(&mut self) -> Option<GuardedStr>

Attempt to lex for a guarded string literal.

Used by rustc_parse::lexer to lex for guarded strings conditionally based on edition.

Note: this will not reset the Cursor when a guarded string is not found. It is the caller’s responsibility to do so.