Struct flate2::bufread::MultiGzDecoder[][src]

pub struct MultiGzDecoder<R>(_);

A gzip streaming decoder that decodes all members of a multistream

A gzip member consists of a header, compressed data and a trailer. The gzip specification, however, allows multiple gzip members to be joined in a single stream. MultiGzDecoder will decode all consecutive members while GzDecoder will only decompress the first gzip member. The multistream format is commonly used in bioinformatics, for example when using the BGZF compressed data.

This structure exposes a BufRead interface that will consume all gzip members from the underlying reader and emit uncompressed data.

Examples

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

// 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 = MultiGzDecoder::new(&bytes[..]);
   let mut s = String::new();
   gz.read_to_string(&mut s)?;
   Ok(s)
}

Implementations

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

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

Notable traits for MultiGzDecoder<R>

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

Creates a new decoder from the given reader, immediately parsing the (first) gzip header. If the gzip stream contains multiple members all will be decoded.

impl<R> MultiGzDecoder<R>[src]

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

Returns the current header associated with this stream, if it’s 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 MultiGzDecoder<R>[src]

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

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

Auto Trait Implementations

impl<R> !RefUnwindSafe for MultiGzDecoder<R>

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

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

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

impl<R> !UnwindSafe for MultiGzDecoder<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.