Struct flate2::bufread::MultiGzDecoder [−][src]
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]
Notable traits for MultiGzDecoder<R>
impl<R: BufRead> Read for MultiGzDecoder<R>impl<R: BufRead + Write> Write for 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.
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]
fn read(&mut self, into: &mut [u8]) -> Result<usize>
[src]
pub fn read_vectored(
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>
1.36.0[src]
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>
pub fn is_read_vectored(&self) -> bool
[src]
pub unsafe fn initializer(&self) -> Initializer
[src]
pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
1.0.0[src]
pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
pub fn by_ref(&mut self) -> &mut Self
1.0.0[src]
pub fn bytes(self) -> Bytes<Self>
1.0.0[src]
pub fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
pub fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
impl<R: BufRead + Write> Write for MultiGzDecoder<R>
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
fn flush(&mut self) -> Result<()>
[src]
pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>
1.36.0[src]
pub fn is_write_vectored(&self) -> bool
[src]
pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
pub fn write_all_vectored(
&mut self,
bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>
[src]
&mut self,
bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>
pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>
1.0.0[src]
pub fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Auto Trait Implementations
impl<R> !RefUnwindSafe for MultiGzDecoder<R>
impl<R> Send for MultiGzDecoder<R> where
R: Send,
R: Send,
impl<R> Sync for MultiGzDecoder<R> where
R: Sync,
R: Sync,
impl<R> Unpin for MultiGzDecoder<R> where
R: Unpin,
R: Unpin,
impl<R> !UnwindSafe for MultiGzDecoder<R>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,