Struct zstd::stream::write::Decoder

pub struct Decoder<'a, W: Write> { /* private fields */ }

A decoder that decompress and forward data to another writer.

Note that you probably want to flush() after writing your stream content. You can use auto_flush() to automatically flush the writer on drop.

Implementations

impl<W: Write> Decoder<'static, W>

pub fn new(writer: W) -> Result<Self>

Creates a new decoder.

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

Creates a new decoder, using an existing dictionary.

(Provides better compression ratio for small files, but requires the dictionary to be present during decompression.)

impl<'a, W: Write> Decoder<'a, W>

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

Creates a new decoder, using an existing prepared DecoderDictionary.

(Provides better compression ratio for small files, but requires the dictionary to be present during decompression.)

pub fn get_ref(&self) -> &W

Acquires a reference to the underlying writer.

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

Acquires a mutable reference to the underlying writer.

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

pub fn into_inner(self) -> W

Returns the inner Write.

pub fn recommended_input_size() -> usize

Return a recommendation for the size of data to write at once.

pub fn auto_flush(self) -> AutoFlushDecoder<'a, W>

Returns a wrapper around self that will flush the stream on drop.

Panic

Panics on drop if an error happens when flushing the stream.

pub fn on_flush<F: FnMut(Result<()>)>(self, f: F) -> AutoFlushDecoder<'a, W, F>

Returns a decoder that will flush the stream on drop.

Calls the given callback with the result from flush().

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.

Trait Implementations

impl<W: Write> Write for Decoder<'_, W>

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 is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers 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” adapter for this instance of Write.