Struct MzstdDecoder 

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

Available on async_compression_unstable and crate feature futures-io and crate feature zstd-mzstd only.

A zstd-mzstd 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: AsyncWrite> MzstdDecoder<W>

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

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

pub fn with_codec(read: W, codec: MzstdDecoder) -> MzstdDecoder<W>

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

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

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

Panics

Panics if a parameter is out of range.

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

Creates a new decoder, using the specified 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> MzstdDecoder<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 Self>) -> 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> AsyncBufRead for MzstdDecoder<W>

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

Attempt 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 Self>, 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> AsyncRead for MzstdDecoder<W>

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

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

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<W: AsyncWrite> AsyncWrite for MzstdDecoder<W>

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

Attempt to write bytes from buf into the object.

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

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

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

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

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<W: Debug> Debug for MzstdDecoder<W>

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

Formats the value using the given formatter.

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

where PinnedFieldsOf<__Origin<'__pin, W>>: Unpin,