Struct flate2::bufread::MultiGzDecoder
source · [−]pub struct MultiGzDecoder<R>(_);
Expand description
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
sourceimpl<R: BufRead> MultiGzDecoder<R>
impl<R: BufRead> MultiGzDecoder<R>
sourcepub fn new(r: R) -> MultiGzDecoder<R>
pub fn new(r: R) -> MultiGzDecoder<R>
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.
sourceimpl<R> MultiGzDecoder<R>
impl<R> MultiGzDecoder<R>
sourcepub fn header(&self) -> Option<&GzHeader>
pub fn header(&self) -> Option<&GzHeader>
Returns the current header associated with this stream, if it’s valid
sourcepub fn get_mut(&mut self) -> &mut R
pub fn get_mut(&mut self) -> &mut R
Acquires a mutable reference to the underlying stream.
Note that mutation of the stream may result in surprising results if this decoder is continued to be used.
sourcepub fn into_inner(self) -> R
pub fn into_inner(self) -> R
Consumes this decoder, returning the underlying reader.
Trait Implementations
sourceimpl<R: Debug> Debug for MultiGzDecoder<R>
impl<R: Debug> Debug for MultiGzDecoder<R>
sourceimpl<R: BufRead> Read for MultiGzDecoder<R>
impl<R: BufRead> Read for MultiGzDecoder<R>
sourcefn read(&mut self, into: &mut [u8]) -> Result<usize>
fn read(&mut self, into: &mut [u8]) -> Result<usize>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
read
, except that it reads into a slice of buffers. Read morefn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
buf
. Read morefn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
buf
. Read morefn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
buf
. Read morefn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
cursor
. Read morefn by_ref(&mut self) -> &mut Self
fn by_ref(&mut self) -> &mut Self
Read
. Read more