Struct BufferedInput

pub struct BufferedInput<T: Iterator<Item = char>> { /* private fields */ }

A wrapper around an Iterator of chars with a buffer.

The YAML scanner often needs some lookahead. With fully allocated buffers such as String or &str, this is not an issue. However, with streams, we need to have a way of peeking multiple characters at a time and sometimes pushing some back into the stream. There is no “easy” way of doing this without itertools. In order to avoid pulling the entierty of itertools for one method, we use this structure.

Implementations

impl<T: Iterator<Item = char>> BufferedInput<T>

pub fn new(input: T) -> Self

Create a new BufferedInput with the given input.

Trait Implementations

impl<T: Iterator<Item = char>> Input for BufferedInput<T>

fn lookahead(&mut self, count: usize)

A hint to the input source that we will need to read count characters.

fn buflen(&self) -> usize

Return the number of buffered characters in self.

fn bufmaxlen(&self) -> usize

Return the capacity of the buffer in self.

fn raw_read_ch(&mut self) -> char

Read a character from the input stream and return it directly.

fn raw_read_non_breakz_ch(&mut self) -> Option<char>

Read a non-breakz a character from the input stream and return it directly.

fn skip(&mut self)

Consume the next character.

fn skip_n(&mut self, count: usize)

Consume the next count character.

fn peek(&self) -> char

Return the next character, without consuming it.

fn peek_nth(&self, n: usize) -> char

Return the n-th character in the buffer, without consuming it.

fn buf_is_empty(&self) -> bool

Return whether the buffer (!= stream) is empty.

fn look_ch(&mut self) -> char

Look for the next character and return it.

fn next_char_is(&self, c: char) -> bool

Return whether the next character in the input source is equal to c.

fn nth_char_is(&self, n: usize, c: char) -> bool

Return whether the n-th character in the input source is equal to c.

fn next_2_are(&self, c1: char, c2: char) -> bool

Return whether the next 2 characters in the input source match the given characters.

fn next_3_are(&self, c1: char, c2: char, c3: char) -> bool

Return whether the next 3 characters in the input source match the given characters.

fn next_is_document_indicator(&self) -> bool

Check whether the next characters correspond to a document indicator.

fn next_is_document_start(&self) -> bool

Check whether the next characters correspond to a start of document.

fn next_is_document_end(&self) -> bool

Check whether the next characters correspond to an end of document.

fn skip_ws_to_eol( &mut self, skip_tabs: SkipTabs, ) -> (usize, Result<SkipTabs, &'static str>)

Skip yaml whitespace at most up to eol. Also skips comments. Advances the input.

fn next_can_be_plain_scalar(&self, in_flow: bool) -> bool

Check whether the next characters may be part of a plain scalar.

fn next_is_blank_or_break(&self) -> bool

Check whether the next character is a blank or a break.

fn next_is_blank_or_breakz(&self) -> bool

Check whether the next character is a blank or a breakz.

fn next_is_blank(&self) -> bool

Check whether the next character is a blank.

fn next_is_break(&self) -> bool

Check whether the next character is a break.

fn next_is_breakz(&self) -> bool

Check whether the next character is a breakz.

fn next_is_z(&self) -> bool

Check whether the next character is a z.

fn next_is_flow(&self) -> bool

Check whether the next character is a flow.

fn next_is_digit(&self) -> bool

Check whether the next character is a digit.

fn next_is_alpha(&self) -> bool

Check whether the next character is a letter.

fn skip_while_non_breakz(&mut self) -> usize

Skip characters from the input until a breakz is found.

fn skip_while_blank(&mut self) -> usize

Skip characters from the input while blanks are found.

fn fetch_while_is_alpha(&mut self, out: &mut String) -> usize

Fetch characters from the input while we encounter letters and store them in out.