Struct buffered_reader::Zlib

pub struct Zlib<R: BufferedReader<C>, C: Debug + Sync + Send> { /* fields omitted */ }

Decompresses the underlying BufferedReader using the zlib algorithm.

Implementations

impl<R: BufferedReader<()>> Zlib<R, ()>

pub fn new(reader: R) -> Self

Instantiates a new zlib decompression reader.

reader is the source to wrap.

impl<R: BufferedReader<C>, C: Debug + Sync + Send> Zlib<R, C>

pub fn with_cookie(reader: R, cookie: C) -> Self

Like new(), but uses a cookie.

The cookie can be retrieved using the cookie_ref and cookie_mut methods, and set using the cookie_set method.

Trait Implementations

impl<R: BufferedReader<C>, C: Debug + Send + Sync> BufferedReader<C> for Zlib<R, C>

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

Returns a reference to the internal buffer.

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

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

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

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

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

Consumes some of the data.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns a reference to the inner BufferedReader, if any.

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

Returns the underlying reader, if any.

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

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

pub fn cookie_ref(&self) -> &C

Returns a reference to the BufferedReader's cookie.

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

Returns a mutable reference to the BufferedReader's cookie.

pub fn eof(&mut self) -> bool

Checks whether the end of the stream is reached.

pub fn consummated(&mut self) -> bool

Checks whether this reader is consummated.

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

Reads until either terminal is encountered or EOF.

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

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

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

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

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

pub fn dump(&self, sink: &mut dyn Write) -> Result<()> where
    Self: Sized, 

A helpful debugging aid to pretty print a Buffered Reader stack.

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

Boxes the reader.

impl<R: BufferedReader<C>, C: Debug + Sync + Send> Debug for Zlib<R, C>

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

Formats the value using the given formatter.

impl<R: BufferedReader<C>, C: Debug + Sync + Send> Display for Zlib<R, C>

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

Formats the value using the given formatter.

impl<R: BufferedReader<C>, C: Debug + Sync + Send> Read for Zlib<R, C>

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

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

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

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

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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