Struct Cursor 

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

A position in some text, and the bash word grammar over it.

Built by parse_with, which is also what checks that a grammar consumed the whole input.

Implementations

impl<'a> Cursor<'a>

pub fn at(&self) -> usize

The byte offset reached so far.

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

What has not been read yet.

pub fn at_end(&self) -> bool

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

pub fn starts_with(&self, text: &str) -> bool

pub fn fail(&self, message: impl Into<String>) -> ParseError

A refusal at the current position, carrying the text around it.

pub fn eat(&mut self, text: &str) -> bool

Consume text if it is next, and say whether it was.

pub fn lit(&mut self, text: &str) -> Result<(), ParseError>

Consume text, which must be next.

pub fn take_while(&mut self, accept: impl Fn(char) -> bool) -> &'a str

Every leading character the predicate accepts, possibly none.

pub fn ws0(&mut self)

Spaces, tabs and newlines, possibly none.

pub fn word(&mut self, stops: &[char]) -> Result<String, ParseError>

One word: a first segment, then every adjacent one that still belongs to it. The first must be there; a following one that will not read ends the word rather than failing it.