Struct ZlibDecoder

pub struct ZlibDecoder<R> { /* private fields */ }

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::Compression;
# use flate2::write::ZlibEncoder;
use flate2::read::ZlibDecoder;

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

impl<R> ZlibDecoder<R>

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.

fn get_ref(&self) -> &R

Acquires a reference to the underlying stream

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.

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.

fn total_in(&self) -> u64

Returns the number of bytes that the decompressor has consumed.

Note that this will likely be smaller than what the decompressor actually read from the underlying stream due to buffering.

fn total_out(&self) -> u64

Returns the number of bytes that the decompressor has produced.

impl<R: Read> ZlibDecoder<R>

fn new(r: R) -> ZlibDecoder<R>

Creates a new decoder which will decompress data read from the given stream.

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.

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.

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.

Trait Implementations

impl<R: Debug> Debug for ZlibDecoder<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl<R: Read + Write> Write for ZlibDecoder<R>

fn write(&mut self, buf: &[u8]) -> Result<usize>
fn flush(&mut self) -> Result<()>

impl<R: Read> Read for ZlibDecoder<R>

fn read(&mut self, into: &mut [u8]) -> Result<usize>

Auto Trait Implementations

impl<R> !UnwindSafe for ZlibDecoder<R>

impl<R> Freeze for ZlibDecoder<R> where ZlibDecoder<BufReader<R>>: Freeze,

impl<R> RefUnwindSafe for ZlibDecoder<R> where ZlibDecoder<BufReader<R>>: RefUnwindSafe,

impl<R> Send for ZlibDecoder<R> where ZlibDecoder<BufReader<R>>: Send,

impl<R> Sync for ZlibDecoder<R> where ZlibDecoder<BufReader<R>>: Sync,

impl<R> Unpin for ZlibDecoder<R> where ZlibDecoder<BufReader<R>>: Unpin,

impl<R> UnsafeUnpin for ZlibDecoder<R> where ZlibDecoder<BufReader<R>>: UnsafeUnpin,

Blanket Implementations

impl<T> Any for ZlibDecoder<R> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for ZlibDecoder<R> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for ZlibDecoder<R> where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for ZlibDecoder<R>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for ZlibDecoder<R> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for ZlibDecoder<R> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for ZlibDecoder<R> where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>