Struct flate2::read::ZlibDecoder
source · pub struct ZlibDecoder<R> { /* private fields */ }
Expand description
A ZLIB decoder, or decompressor.
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 ZLIB data this reader will return
Ok(0) even if there are more bytes available in the underlying reader.
ZlibDecoder
may have read additional bytes past the end of the ZLIB data.
If you need the following bytes, wrap the Reader
in a std::io::BufReader
and use bufread::ZlibDecoder
instead.
§Examples
use std::io::prelude::*;
use std::io;
use flate2::read::ZlibDecoder;
// Uncompresses a Zlib 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 z = ZlibDecoder::new(&bytes[..]);
let mut s = String::new();
z.read_to_string(&mut s)?;
Ok(s)
}
Implementations§
source§impl<R: Read> ZlibDecoder<R>
impl<R: Read> ZlibDecoder<R>
sourcepub fn new(r: R) -> ZlibDecoder<R> ⓘ
pub fn new(r: R) -> ZlibDecoder<R> ⓘ
Creates a new decoder which will decompress data read from the given stream.
sourcepub fn new_with_buf(r: R, buf: Vec<u8>) -> ZlibDecoder<R> ⓘ
pub fn new_with_buf(r: R, buf: Vec<u8>) -> ZlibDecoder<R> ⓘ
Creates a new decoder which will decompress data read from the given
stream r
, using buf
as backing to speed up reading.
Note that the specified buffer will only be used up to its current length. The buffer’s capacity will also not grow over time.
sourcepub fn new_with_decompress(r: R, decompression: Decompress) -> ZlibDecoder<R> ⓘ
pub fn new_with_decompress(r: R, decompression: Decompress) -> ZlibDecoder<R> ⓘ
Creates a new decoder which will decompress data read from the given
stream r
, along with decompression
settings.
sourcepub fn new_with_decompress_and_buf(
r: R,
buf: Vec<u8>,
decompression: Decompress,
) -> ZlibDecoder<R> ⓘ
pub fn new_with_decompress_and_buf( r: R, buf: Vec<u8>, decompression: Decompress, ) -> ZlibDecoder<R> ⓘ
Creates a new decoder which will decompress data read from the given
stream r
, using buf
as backing to speed up reading,
along with decompression
settings to configure decoder.
Note that the specified buffer will only be used up to its current length. The buffer’s capacity will also not grow over time.
source§impl<R> ZlibDecoder<R>
impl<R> ZlibDecoder<R>
sourcepub fn reset(&mut self, r: R) -> R
pub fn reset(&mut self, r: R) -> R
Resets the state of this decoder entirely, swapping out the input stream for another.
This will reset the internal state of this decoder and replace the
input stream with the one provided, returning the previous input
stream. Future data read from this decoder will be the decompressed
version of r
’s data.
Note that there may be currently buffered data when this function is called, and in that case the buffered data is discarded.
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.
Note that there may be buffered bytes which are not re-acquired as part of this transition. It’s recommended to only call this function after EOF has been reached.
Trait Implementations§
source§impl<R: Debug> Debug for ZlibDecoder<R>
impl<R: Debug> Debug for ZlibDecoder<R>
source§impl<R: Read> Read for ZlibDecoder<R>
impl<R: Read> Read for ZlibDecoder<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 ZlibDecoder<R>
impl<R: Read + Write> Write for ZlibDecoder<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
)