Struct inflate::DeflateDecoder

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

A DEFLATE decoder/decompressor.

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

Example

use std::io::Read;
use inflate::DeflateDecoder;
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 = DeflateDecoder::new(&encoded[..]);
let mut output = Vec::new();
let status = decoder.read_to_end(&mut output);
assert_eq!(String::from_utf8(output).unwrap(), TEST_STRING);

Methods

impl<R: Read> DeflateDecoder<R>

Important traits for DeflateDecoder<R>

impl<R: Read> Read for DeflateDecoder<R>

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

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

Important traits for DeflateDecoder<R>

impl<R: Read> Read for DeflateDecoder<R>

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

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

Important traits for DeflateDecoder<R>

impl<R: Read> Read for DeflateDecoder<R>

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

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

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 get_ref(&self) -> &R

Returns a reference to the underlying reader.

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

Returns a mutable reference to the underlying reader.

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

Returns the total number of bytes output from this decoder.

impl<R> DeflateDecoder<R>

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 total_in(&self) -> u64

Returns the total bytes read from the underlying reader.

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: Read> Read for DeflateDecoder<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.

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 chars(self) -> Chars<Self>

Deprecated since 1.27.0

: Use str::from_utf8 instead: https://doc.rust-lang.org/nightly/std/str/struct.Utf8Error.html#examples

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

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s.

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.