Struct ZstdDecoder

pub struct ZstdDecoder<W> { /* private fields */ }

A zstd decoder, or decompressor

This structure implements an AsyncWrite interface and will take in compressed data and write it uncompressed to an underlying stream.

Implementations

impl<W> ZstdDecoder<W>

where W: AsyncWrite,

pub fn new(read: W) -> ZstdDecoder<W>

Creates a new decoder which will take in compressed data and write it uncompressed to the given stream.

pub fn with_params(inner: W, params: &[DParameter]) -> ZstdDecoder<W>

Creates a new decoder, using the specified parameters, which will read compressed data from the given stream and emit a decompressed stream.

pub fn with_dict(inner: W, dictionary: &[u8]) -> Result<ZstdDecoder<W>, Error>

Creates a new decoder, using the specified compression level and pre-trained dictionary, which will read compressed data from the given stream and emit an uncompressed stream.

Dictionaries provide better compression ratios for small files, but are required to be present during decompression. The dictionary used must be the same as the one used for compression.

Errors

Returns error when dictionary is not valid.

impl<W> ZstdDecoder<W>

pub fn get_ref(&self) -> &W

Acquires a reference to the underlying reader that this decoder is wrapping.

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

Acquires a mutable reference to the underlying reader that this decoder is wrapping.

Note that care must be taken to avoid tampering with the state of the reader which may otherwise confuse this decoder.

pub fn get_pin_mut(self: Pin<&mut ZstdDecoder<W>>) -> Pin<&mut W>

Acquires a pinned mutable reference to the underlying reader that this decoder is wrapping.

Note that care must be taken to avoid tampering with the state of the reader which may otherwise confuse this decoder.

pub fn into_inner(self) -> W

Consumes this decoder returning the underlying reader.

Note that this may discard internal state of this decoder, so care should be taken to avoid losing resources when this is called.

Trait Implementations

impl<W> AsyncBufRead for ZstdDecoder<W>

where W: AsyncBufRead,

fn poll_fill_buf( self: Pin<&mut ZstdDecoder<W>>, cx: &mut Context<'_>, ) -> Poll<Result<&[u8], Error>>

Attempts to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut ZstdDecoder<W>>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<W> AsyncRead for ZstdDecoder<W>

where W: AsyncRead,

fn poll_read( self: Pin<&mut ZstdDecoder<W>>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<(), Error>>

Attempts to read from the AsyncRead into buf.

impl<W> AsyncWrite for ZstdDecoder<W>

where W: AsyncWrite,

fn poll_write( self: Pin<&mut ZstdDecoder<W>>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush( self: Pin<&mut ZstdDecoder<W>>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut ZstdDecoder<W>>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

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

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<W> Debug for ZstdDecoder<W>

where W: Debug,

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

Formats the value using the given formatter.

impl<'__pin, W> Unpin for ZstdDecoder<W>

where <PinnedFieldsOfHelperStruct<__Origin<'__pin, W>> as PinnedFieldsOfHelperTrait>::Actual: Unpin,