A decoder for a single member of a gzip file.

This structure implements a Read interface. When read from, it reads compressed data from the underlying BufRead and provides the uncompressed data.

After reading a single member of the gzip data this reader will return Ok(0) even if there are more bytes available in the underlying reader. If you need the following bytes, call into_inner() after Ok(0) to recover the underlying reader.

To handle gzip files that may have multiple members, see MultiGzDecoder or read more in the introduction.

Examples

use std::io::prelude::*;
use std::io;
# use flate2::Compression;
# use flate2::write::GzEncoder;
use flate2::bufread::GzDecoder;

# fn main() {
#   let mut e = GzEncoder::new(Vec::new(), Compression::default());
#   e.write_all(b"Hello World").unwrap();
#   let bytes = e.finish().unwrap();
#   println!("{}", decode_reader(bytes).unwrap());
# }
#
// 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)
}