Struct buffered_reader::Generic

pub struct Generic<T: Read, C> {
    pub reader: Box<T>,
    // some fields omitted
}

Wraps a Reader.

This is useful when reading from a file, and it even works with a &[u8] (but Memory is more efficient).

Fields

reader: Box<T>

Implementations

impl<T: Read> Generic<T, ()>

pub fn new(reader: T, preferred_chunk_size: Option<usize>) -> Self

Instantiate a new generic reader. reader is the source to wrap. preferred_chuck_size is the preferred chuck size. If None, then the default will be used, which is usually what you want.

impl<T: Read, C> Generic<T, C>

pub fn with_cookie(
    reader: T,
    preferred_chunk_size: Option<usize>,
    cookie: C
) -> Self

Like new(), but sets a cookie, which can be retrieved using the cookie_ref and cookie_mut methods, and set using the cookie_set method.

Trait Implementations

impl<T: Read, C> BufferedReader<C> for Generic<T, C>

fn buffer(&self) -> &[u8]

Returns a reference to the internal buffer.

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

Ensures that the internal buffer has at least amount bytes of data, and returns it.

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

Like data(), but returns an error if there is not at least amount bytes available.

fn consume(&mut self, amount: usize) -> &[u8]

Consumes some of the data.

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

A convenience function that combines data() and consume().

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

A convenience function that effectively combines data_hard() and consume().

fn get_mut(&mut self) -> Option<&mut dyn BufferedReader<C>>

Returns a mutable reference to the inner BufferedReader, if any.

fn get_ref(&self) -> Option<&dyn BufferedReader<C>>

Returns a reference to the inner BufferedReader, if any.

fn into_inner<'b>(self: Box<Self>) -> Option<Box<dyn BufferedReader<C> + 'b>> where
    Self: 'b, 

Returns the underlying reader, if any.

fn cookie_set(&mut self, cookie: C) -> C

Sets the BufferedReader's cookie and returns the old value.

fn cookie_ref(&self) -> &C

Returns a reference to the BufferedReader's cookie.

fn cookie_mut(&mut self) -> &mut C

Returns a mutable reference to the BufferedReader's cookie.

fn data_eof(&mut self) -> Result<&[u8], Error>

Returns all of the data until EOF. Like data(), this does not actually consume the data that is read.

fn eof(&mut self) -> bool

Checks whether the end of the stream is reached.

fn consummated(&mut self) -> bool

Checks whether this reader is consummated.

fn read_be_u16(&mut self) -> Result<u16, Error>

A convenience function for reading a 16-bit unsigned integer in big endian format.

fn read_be_u32(&mut self) -> Result<u32, Error>

A convenience function for reading a 32-bit unsigned integer in big endian format.

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

Reads until either terminal is encountered or EOF.

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

Discards the input until one of the bytes in terminals is encountered.

fn drop_through(
    &mut self,
    terminals: &[u8],
    match_eof: bool
) -> Result<(Option<u8>, usize), Error>

Discards the input until one of the bytes in terminals is encountered.

fn steal(&mut self, amount: usize) -> Result<Vec<u8>, Error>

Like data_consume_hard(), but returns the data in a caller-owned buffer.

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

Like steal(), but instead of stealing a fixed number of bytes, steals all of the data until the end of file.

fn drop_eof(&mut self) -> Result<bool, Error>

Like steal_eof(), but instead of returning the data, the data is discarded.

fn as_boxed<'a>(self) -> Box<dyn BufferedReader<C> + 'a> where
    Self: 'a + Sized, 

Boxes the reader.

impl<T: Read, C> Debug for Generic<T, C>

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

Formats the value using the given formatter.

impl<T: Read, C> Display for Generic<T, C>

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

Formats the value using the given formatter.

impl<T: Read, C> Read for Generic<T, C>

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>) -> 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.