Struct flate2::read::ZlibDecoder

[+] Show declaration

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

[−] Expand description

A ZLIB decoder, or decompressor.

This structure implements a Read interface and takes a stream of compressed data as input, providing the decompressed data when read from.

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)
}

Methods

impl<R: Read> ZlibDecoder<R>[−]

Important traits for ZlibDecoder<R>

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

pub fn new(r: R) -> ZlibDecoder<R>[−]

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

Important traits for ZlibDecoder<R>

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

pub fn new_with_buf(r: R, buf: Vec<u8>) -> ZlibDecoder<R>[−]

Same as new, but the intermediate buffer for data is specified.

Note that the specified buffer will only be used up to its current length. The buffer's capacity will also not grow over time.

impl<R> ZlibDecoder<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.

pub fn get_ref(&self) -> &R[−]

Acquires a reference to the underlying stream

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 encoder is continued to be used.

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.

pub 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.

pub fn total_out(&self) -> u64[−]

Returns the number of bytes that the decompressor has produced.

Trait Implementations

impl<R: Debug> Debug for ZlibDecoder<R>[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl<R: Read> Read for ZlibDecoder<R>[+]

[+] Show hidden undocumented items

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>[−]

Like read, except that it reads into a slice of buffers.

unsafe fn initializer(&self) -> Initializer[−]

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>[−]

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>[−]

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>[−]

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self[−]

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>[−]

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, [−]

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>[−]

Creates an adaptor which will read at most limit bytes from it.

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

[+] Show hidden undocumented items

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

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>[−]

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>[−]

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>[−]

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>[−]

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self[−]

Creates a "by reference" adaptor for this instance of Write.