Struct zstd::stream::read::Decoder

pub struct Decoder<'a, R: BufRead> { /* private fields */ }

A decoder that decompress input data from another Read.

This allows to read a stream of compressed data (good for files or heavy network stream).

Implementations

impl<R: Read> Decoder<'static, BufReader<R>>

pub fn new(reader: R) -> Result<Self>

Creates a new decoder.

impl<R: BufRead> Decoder<'static, R>

pub fn with_buffer(reader: R) -> Result<Self>

Creates a new decoder around a BufRead.

pub fn with_dictionary(reader: R, dictionary: &[u8]) -> Result<Self>

Creates a new decoder, using an existing dictionary.

The dictionary must be the same as the one used during compression.

impl<'a, R: BufRead> Decoder<'a, R>

pub fn single_frame(self) -> Self

Sets this Decoder to stop after the first frame.

By default, it keeps concatenating frames until EOF is reached.

pub fn with_prepared_dictionary<'b>(
    reader: R,
    dictionary: &DecoderDictionary<'b>
) -> Result<Self> where
    'b: 'a, 

Creates a new decoder, using an existing DecoderDictionary.

The dictionary must be the same as the one used during compression.

pub fn recommended_output_size() -> usize

Recommendation for the size of the output buffer.

pub fn get_ref(&self) -> &R

Acquire a reference to the underlying reader.

pub fn get_mut(&mut self) -> &mut R

Acquire a mutable reference to the underlying reader.

Note that mutation of the reader may result in surprising results if this decoder is continued to be used.

pub fn finish(self) -> R

Return the inner Read.

Calling finish() is not required after reading a stream - just use it if you need to get the Read back.

pub fn set_parameter(&mut self, parameter: DParameter) -> Result<()>

Sets a decompression parameter on the decompression stream.

pub fn window_log_max(&mut self, log_distance: u32) -> Result<()>

Sets the maximum back-reference distance.

The actual maximum distance is going to be 2^log_distance.

This will need to at least match the value set when compressing.

pub fn include_magicbytes(&mut self, include_magicbytes: bool) -> Result<()>

Available on crate feature experimental only.

Enables or disabled expecting the 4-byte magic header

Only available with the experimental feature.

This will need to match the settings used when compressing.

Trait Implementations

impl<R: BufRead> Read for Decoder<'_, R>

fn read(&mut self, buf: &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.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> 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 read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

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

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 adapter which will chain this stream with another.

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

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