Struct sigma_ser::peekable_reader::PeekableReader

pub struct PeekableReader<R> { /* fields omitted */ }

from https://github.com/C4K3/peekable-reader-rs/blob/master/src/lib.rs A wrapper around any struct implementing the Read trait, additionally allowing for peek operations to be performed. Therefore, the PeekableReader struct also implements the Read trait.

The primary invariant of the PeekableReader is that after calling the peek method, the next read_byte call will return the same result as the peek does. When the result is a byte (read off the wrapped reader), any read-type method of the Reader trait will include the byte as the first one. On the other hand, if the result is an io::Error, the error will be returned regardless of which read-type method of the Reader is invoked. Consecutive peeks before any read-type operation is used always return the same io::Result.

When using peek_u8 you will get a Result<u8, &Error>, while when you call any of the Read functions you will get an io::Result, thereby consuming the io::Error (if any.)

Implementations

impl<R: Read> PeekableReader<R>

pub fn new(reader: R) -> PeekableReader<R>

Initializes a new PeekableReader which wraps the given underlying reader.

Trait Implementations

impl<R: Read> Peekable for PeekableReader<R>

fn peek_u8(&mut self) -> Result<u8, &Error>

Returns the io::Result which the Reader will return on the next get_byte call.

If the io::Result is indeed an io::Error, the error will be returned for any subsequent read operation invoked upon the Reader.

impl<R: Read> Read for PeekableReader<R>

fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.