Struct lazy_reader::Reader

pub struct Reader<D: Decoder, Read> {
    pub reader: Read,
    pub buffer: Vec<D::Word>,
    pub result: String,
    pub offset: usize,
    pub length: usize,
    pub character: Char<Error>,
}

A buffered reader able to efficiently read big inputs in constant memory.

It supports various encodings via Decoder and also bookmarks which allow it to return back to a character at specific offset.

Fields

reader: Read

The reader that holds the input.

buffer: Vec<D::Word>

The buffer that stores the input data.

result: String

The string representation of data that has been read.

offset: usize

The buffer offset of the current element read.

length: usize

The number of elements stored in buffer.

character: Char<Error>

The last character read.

Implementations

impl<D: Decoder, R: Read<Item = D::Word>> Reader<D, R>

pub fn new(reader: R, _decoder: D) -> Self

Creates a new instance of the reader.

Trait Implementations

impl<D: Clone + Decoder, Read: Clone> Clone for Reader<D, Read> where
    D::Word: Clone, 

fn clone(&self) -> Reader<D, Read>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<D: Debug + Decoder, Read: Debug> Debug for Reader<D, Read> where
    D::Word: Debug, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<D: PartialEq + Decoder, Read: PartialEq> PartialEq<Reader<D, Read>> for Reader<D, Read> where
    D::Word: PartialEq, 

fn eq(&self, other: &Reader<D, Read>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Reader<D, Read>) -> bool

This method tests for !=.

impl<D: Decoder, R: Read<Item = D::Word>> ReaderOps for Reader<D, R>

fn next_char(&mut self, bookmarks: &mut BookmarkManager) -> Result<char, Error>

Read the next character from input.

fn advance_char(&mut self, bookmarks: &mut BookmarkManager)

Advance along the input without returning the character.

fn character(&self) -> Char<Error>

Get the current character from the reader.

fn finished(&self, _bookmarks: &BookmarkManager) -> bool

Check if the reader has finished reading.

fn empty(&self) -> bool

Check if the reader is empty.

fn fill(&mut self, bookmarks: &mut BookmarkManager)

Fill the buffer with words from the input.

fn max_possible_rewind_len(&self, bookmarks: &BookmarkManager) -> usize

Get the maximum possible rewind for the reader.

fn append_result(&mut self, char: char)

Append the provided character to the reader’s result.

fn pop_result(&mut self) -> String

Return self.result and sets the internal result to empty.

fn offset(&self) -> usize

Get the reader’s current offset in the buffer.

fn result(&self) -> &String

Get an immutable reference to the reader’s result.

fn result_mut(&mut self) -> &mut String

Get a mutable reference to the reader’s result.

fn buffer_len(&self) -> usize

Get the current length of the reader’s buffer.

fn set_offset(&mut self, off: usize)

Set the buffer offset to the specified value.

fn truncate_match(&mut self, len: usize)

Truncate the current match to the provided length.

impl<D: Decoder, Read> StructuralPartialEq for Reader<D, Read>