pub struct GzDecoder<R> { /* private fields */ }
Expand description
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 Read
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.
GzDecoder
may have read additional bytes past the end of the gzip data.
If you need the following bytes, wrap the Reader
in a std::io::BufReader
and use bufread::GzDecoder
instead.
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::read::GzDecoder;
// Uncompresses a Gz Encoded vector of bytes and returns a string or error
// Here &[u8] implements Read
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§
source§impl<R> GzDecoder<R>
impl<R> GzDecoder<R>
sourcepub fn header(&self) -> Option<&GzHeader>
pub fn header(&self) -> Option<&GzHeader>
Returns the header associated with this stream, if it was valid.
sourcepub fn get_ref(&self) -> &R
pub fn get_ref(&self) -> &R
Acquires a reference to the underlying reader.
Note that the decoder may have read past the end of the gzip data.
To prevent this use bufread::GzDecoder
instead.
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 continues to be used.
Note that the decoder may have read past the end of the gzip data.
To prevent this use bufread::GzDecoder
instead.
sourcepub fn into_inner(self) -> R
pub fn into_inner(self) -> R
Consumes this decoder, returning the underlying reader.
Note that the decoder may have read past the end of the gzip data.
Subsequent reads will skip those bytes. To prevent this use
bufread::GzDecoder
instead.
Trait Implementations§
source§impl<R: Read> Read for GzDecoder<R>
impl<R: Read> Read for GzDecoder<R>
source§fn read(&mut self, into: &mut [u8]) -> Result<usize>
fn read(&mut self, into: &mut [u8]) -> Result<usize>
1.36.0 · source§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 moresource§fn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
can_vector
)1.0.0 · source§fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
buf
. Read more1.0.0 · source§fn 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 more1.6.0 · source§fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
buf
. Read moresource§fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)source§fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)cursor
. Read more1.0.0 · source§fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Read
. Read moresource§impl<R: Read + Write> Write for GzDecoder<R>
impl<R: Read + Write> Write for GzDecoder<R>
source§fn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
source§fn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
source§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)1.0.0 · source§fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
source§fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored
)