Struct Scanner 

pub struct Scanner<T, R>
where
    T: Read + Sized,
    R: Clone,
{ /* private fields */ }

Available on crate feature std only.

A Scanner is a forward lookahead struct that scans through an stream of data looking for the indicated tokens.

The amount of possible forward lookahead is specified by the internal buffer size of the BufReader

Implementations

impl<T: Read + Sized, R: Clone> Scanner<T, R>

pub fn new(input: T, delimiters: &[Token<R>]) -> Self

Creates a scanner with the default buffer capacity, 8KB

pub fn with_max_lookahead( input: T, max_buffer: usize, delimiters: &[Token<R>], ) -> Self

Creates a scanner with the specified buffer capacity

pub fn scan_until_next(&mut self) -> Result<FoundToken<'_, R>, Error>

Scans through the buffer, looking for the specified token. Returns the number of bytes in the stream needed to position the cursor to JUST BEFORE the token. I.E., after calling read_exact(scan_until()), the next call to read() will return the token itself.

Returns Ok(N) if it found the token in the input stream, or hit the end of the buffer without finding the token Returns Ok(None) if there are no additional characters to read in the buffer - we’ve hit EOF. Returns Err(e) if there’s an error reading from the underlying stream

pub fn read_next(&mut self) -> Result<ReadToken<'_, R>, Error>

pub fn consume(&mut self, len: usize)

pub fn take_back(self) -> Buffer<BufReader<T>>

impl<T: Read + Sized> Scanner<T, LineEnding>

pub fn new_lf(input: T) -> Self

pub fn new_crlf(input: T) -> Self

pub fn new_cr(input: T) -> Self