Struct DeflateDecoderBuf

pub struct DeflateDecoderBuf<R> { /* private fields */ }

A DEFLATE decoder/decompressor.

This structure implements a Read interface and takes a stream of compressed data that implements the BufRead trait as input, providing the decompressed data when read from.

Example

use std::io::Read;
use inflate::DeflateDecoderBuf;

const TEST_STRING: &'static str = "Hello, world";
let encoded = vec![243, 72, 205, 201, 201, 215, 81, 40, 207, 47, 202, 73, 1, 0];
let mut decoder = DeflateDecoderBuf::new(&encoded[..]);
let mut output = Vec::new();
let status = decoder.read_to_end(&mut output);
assert_eq!(String::from_utf8(output).unwrap(), TEST_STRING);

Implementations

impl<R: BufRead> DeflateDecoderBuf<R>

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

Create a new Deflatedecoderbuf to read from a raw deflate stream.

pub fn from_zlib(reader: R) -> DeflateDecoderBuf<R>

Create a new DeflateDecoderbuf that reads from a zlib wrapped deflate stream.

pub fn from_zlib_no_checksum(reader: R) -> DeflateDecoderBuf<R>

Create a new DeflateDecoderbuf that reads from a zlib wrapped deflate stream. without calculating and validating the checksum.

impl<R> DeflateDecoderBuf<R>

pub fn reset(&mut self, r: R) -> R

Resets the decompressor, and replaces the current inner BufRead instance by r. without doing any extra reallocations.

Note that this function doesn’t ensure that all data has been output.

pub fn reset_data(&mut self)

Resets the decoder, but continue to read from the same reader.

Note that this function doesn’t ensure that all data has been output.

pub fn get_ref(&self) -> &R

Returns a reference to the underlying BufRead instance.

pub fn get_mut(&mut self) -> &mut R

Returns a mutable reference to the underlying BufRead instance.

Note that mutation of the reader may cause surprising results if the decoder is going to keep being used.

pub fn into_inner(self) -> R

Drops the decoder and return the inner BufRead instance.

Note that this function doesn’t ensure that all data has been output.

pub fn total_in(&self) -> u64

Returns the total bytes read from the underlying BufRead instance.

pub fn total_out(&self) -> u64

Returns the total number of bytes output from this decoder.

pub fn current_checksum(&self) -> u32

Returns the calculated checksum value of the currently decoded data.

Will return 0 for cases where the checksum is not validated.

Trait Implementations

impl<R: BufRead> Read for DeflateDecoderBuf<R>

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

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.

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

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

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

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

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

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

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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