Struct flate2::bufread::GzDecoder[][src]

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

A gzip streaming decoder

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::GzDecoder;

// Uncompresses a Gz Encoded vector of bytes and returns a string or error
// Here &[u8] implements BufRead

fn decode_reader(bytes: Vec<u8>) -> io::Result<String> {
   let mut gz = GzDecoder::new(&bytes[..]);
   let mut s = String::new();
   gz.read_to_string(&mut s)?;
   Ok(s)
}

Implementations

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

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

Notable traits for GzDecoder<R>

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

Creates a new decoder from the given reader, immediately parsing the gzip header.

impl<R> GzDecoder<R>[src]

pub fn header(&self) -> Option<&GzHeader>[src]

Returns the header associated with this stream, if it was valid

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

Acquires a reference to the underlying reader.

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.

Trait Implementations

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

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

impl<R: BufRead + Write> Write for GzDecoder<R>[src]

Auto Trait Implementations

impl<R> !RefUnwindSafe for GzDecoder<R>

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

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

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

impl<R> !UnwindSafe for GzDecoder<R>

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.