Struct zstd::stream::write::Decoder

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

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§

source§

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

source

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

Creates a new decoder.

source

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

source§

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

source

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

source

pub fn get_ref(&self) -> &W

Acquires a reference to the underlying writer.

source

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.

source

pub fn into_inner(self) -> W

Returns the inner Write.

source

pub fn recommended_input_size() -> usize

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

source

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.

source

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().

source

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

Sets a decompression parameter on the decompression stream.

source

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§

source§

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

source§

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

Write a buffer into this writer, returning how many bytes were written. Read more
source§

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · source§

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

Like write, except that it writes from a slice of buffers. Read more
source§

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. Read more
1.0.0 · source§

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

Attempts to write an entire buffer into this writer. Read more
source§

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. Read more
1.0.0 · source§

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more

Auto Trait Implementations§

§

impl<'a, W> RefUnwindSafe for Decoder<'a, W>where W: RefUnwindSafe,

§

impl<'a, W> Send for Decoder<'a, W>where W: Send,

§

impl<'a, W> !Sync for Decoder<'a, W>

§

impl<'a, W> Unpin for Decoder<'a, W>where W: Unpin,

§

impl<'a, W> UnwindSafe for Decoder<'a, W>where W: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.