Struct flate2::bufread::DeflateDecoder[][src]

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

A DEFLATE decoder, or decompressor.

This structure consumes a BufRead interface, reading compressed data from the underlying reader, and emitting uncompressed data.

Examples

use std::io::prelude::*;
use std::io;
use flate2::bufread::DeflateDecoder;

// Uncompresses a Deflate Encoded vector of bytes and returns a string or error
// Here &[u8] implements Read
fn decode_reader(bytes: Vec<u8>) -> io::Result<String> {
   let mut deflater = DeflateDecoder::new(&bytes[..]);
   let mut s = String::new();
   deflater.read_to_string(&mut s)?;
   Ok(s)
}

Implementations

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

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

Notable traits for DeflateDecoder<R>

impl<R: BufRead> Read for DeflateDecoder<R>impl<W: BufRead + Write> Write for DeflateDecoder<W>
[src]

Creates a new decoder which will decompress data read from the given stream.

impl<R> DeflateDecoder<R>[src]

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

Resets the state of this decoder entirely, swapping out the input stream for another.

This will reset the internal state of this decoder and replace the input stream with the one provided, returning the previous input stream. Future data read from this decoder will be the decompressed version of r’s data.

pub fn reset_data(&mut self)[src]

Resets the state of this decoder’s data

This will reset the internal state of this decoder. It will continue reading from the same stream.

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

Acquires a reference to the underlying stream

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

Acquires a mutable reference to the underlying stream

Note that mutation of the stream may result in surprising results if this encoder is continued to be used.

pub fn into_inner(self) -> R[src]

Consumes this decoder, returning the underlying reader.

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

Returns the number of bytes that the decompressor has consumed.

Note that this will likely be smaller than what the decompressor actually read from the underlying stream due to buffering.

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

Returns the number of bytes that the decompressor has produced.

Trait Implementations

impl<R: Debug> Debug for DeflateDecoder<R>[src]

impl<R: BufRead> Read for DeflateDecoder<R>[src]

impl<W: BufRead + Write> Write for DeflateDecoder<W>[src]

Auto Trait Implementations

impl<R> RefUnwindSafe for DeflateDecoder<R> where
    R: RefUnwindSafe

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

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

impl<R> Unpin for DeflateDecoder<R> where
    R: Unpin

impl<R> UnwindSafe for DeflateDecoder<R> where
    R: UnwindSafe

Blanket Implementations

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

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

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

impl<T> From<T> for T[src]

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.