[][src]Struct inflate::DeflateDecoderBuf

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

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

Methods

impl<R: BufRead> DeflateDecoderBuf<R>[src]

Important traits for DeflateDecoderBuf<R>
pub fn new(reader: R) -> DeflateDecoderBuf<R>[src]

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

Important traits for DeflateDecoderBuf<R>
pub fn from_zlib(reader: R) -> DeflateDecoderBuf<R>[src]

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

Important traits for DeflateDecoderBuf<R>
pub fn from_zlib_no_checksum(reader: R) -> DeflateDecoderBuf<R>[src]

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

impl<R> DeflateDecoderBuf<R>[src]

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

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)[src]

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[src]

Returns a reference to the underlying BufRead instance.

pub fn get_mut(&mut self) -> &mut R[src]

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[src]

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[src]

Returns the total bytes read from the underlying BufRead instance.

pub fn total_out(&self) -> u64[src]

Returns the total number of bytes output from this decoder.

pub fn current_checksum(&self) -> u32[src]

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>[src]

unsafe fn initializer(&self) -> Initializer[src]

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

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

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

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

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

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

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

Read the exact number of bytes required to fill buf. Read more

fn by_ref(&mut self) -> &mut Self
1.0.0
[src]

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

fn bytes(self) -> Bytes<Self>
1.0.0
[src]

Transforms this Read instance to an [Iterator] over its bytes. Read more

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

Creates an adaptor which will chain this stream with another. Read more

fn take(self, limit: u64) -> Take<Self>
1.0.0
[src]

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

Auto Trait Implementations

impl<R> Send for DeflateDecoderBuf<R> where
    R: Send

impl<R> Sync for DeflateDecoderBuf<R> where
    R: Sync

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> From for T[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = !

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

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

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

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]