Struct Reader 

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

Struct that allows formated reading.

Implementations

impl<'a> Reader<'a>

pub fn read_to(&mut self, s: &mut String, max: usize) -> Result<(), ArgError>

Read at most max chars to the given string.

pub fn read_all(&mut self, s: &mut String) -> Result<(), ArgError>

Read all the remaining chars to the given string.

pub fn pos(&self) -> usize

Get the position of the last returned char.

pub fn bytes_size_hint(&self) -> usize

Gets the low estimate of the remaining bytes.

pub fn map_err(&self, e: ArgError) -> ArgError

Adds relevant information to the given error.

pub fn err_parse(&self, msg: impl Into<Cow<'static, str>>) -> ArgError

Creates parse error with the given message.

pub fn err_value(&self, msg: impl Into<Cow<'static, str>>) -> ArgError

Creates value error with the given message.

pub fn map_err_peek(&self, e: ArgError) -> ArgError

Adds relevant information to the given error. The span will start at the next character.

pub fn err_parse_peek(&self, msg: impl Into<Cow<'static, str>>) -> ArgError

Creates parse error with the given message. Span will start at the next character.

pub fn err_value_peek(&self, msg: impl Into<Cow<'static, str>>) -> ArgError

Creates value error with the given message. Span will start at the next character.

pub fn peek(&mut self) -> Result<Option<char>, ArgError>

Peek at the next character.

pub fn expect(&mut self, s: &str) -> Result<(), ArgError>

Match the given string to the output. If it doesn’t match, return error.

pub fn skip_while( &mut self, f: impl FnMut(char) -> bool, ) -> Result<(), ArgError>

Skips characters while the given function matches.

pub fn is_next_some(&mut self, c: char) -> Result<bool, ArgError>

Checks if the next char is the given char. If yes, returns true and moves to the next position.

pub fn is_next( &mut self, p: impl FnOnce(Option<char>) -> bool, ) -> Result<bool, ArgError>

Checks if the next value matches the predicate. If yes, returns true and moves to the next position.

pub fn next(&mut self) -> Result<Option<char>, ArgError>

Gets the next character.

pub fn chars(&mut self) -> ReaderChars<'_, 'a>

Gets iterator over chars.

pub fn parse<'f, T>( &mut self, fmt: &'f ReadFmt<'f>, ) -> Result<(T, Option<ArgError>), ArgError>

where T: FromRead,

Parses the next value.

pub fn trim_left(&mut self, fmt: &ReadFmt<'_>) -> Result<(), ArgError>

Trims characters from the left side according to the given format.

pub fn trim_right(&mut self, fmt: &ReadFmt<'_>) -> Result<(), ArgError>

Trims characters from the right side according to the given format.

pub fn unnext(&mut self, c: char)

Prepends the given character to the reader.

pub fn prepend<I>(&mut self, s: I)

where I: IntoIterator<Item = char>, <I as IntoIterator>::IntoIter: DoubleEndedIterator,

Prepends the given characters to the reader.

Trait Implementations

impl<'a> From<&'a str> for Reader<'a>

fn from(value: &'a str) -> Reader<'a>

Converts to this type from the input type.

impl<'a> From<Box<dyn Iterator<Item = Result<char, ArgError>> + 'a>> for Reader<'a>

fn from( value: Box<dyn Iterator<Item = Result<char, ArgError>> + 'a>, ) -> Reader<'a>

Converts to this type from the input type.

impl<'a> From<Box<dyn Iterator<Item = char> + 'a>> for Reader<'a>

fn from(value: Box<dyn Iterator<Item = char> + 'a>) -> Reader<'a>

Converts to this type from the input type.

impl<'a> From<Box<dyn Read + 'a>> for Reader<'a>

fn from(value: Box<dyn Read + 'a>) -> Reader<'a>

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for Reader<'a>

fn from(value: Cow<'a, str>) -> Reader<'a>

Converts to this type from the input type.

impl From<String> for Reader<'_>

fn from(value: String) -> Reader<'_>

Converts to this type from the input type.