Struct async_compression::tokio::bufread::ZstdDecoder

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

A zstd decoder, or decompressor

This structure implements an AsyncRead interface and will read compressed data from an underlying stream and emit a stream of uncompressed data.

Implementations

impl<R: AsyncBufRead> ZstdDecoder<R>

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

Creates a new decoder which will read compressed data from the given stream and emit a uncompressed stream.

pub fn with_params(inner: R, 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.

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

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.

pub fn multiple_members(&mut self, enabled: bool)

Configure multi-member/frame decoding, if enabled this will reset the decoder state when reaching the end of a compressed member/frame and expect either EOF or another compressed member/frame to follow it in the stream.

pub fn get_ref(&self) -> &R

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

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

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 R>

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

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<R: AsyncBufRead> AsyncRead for ZstdDecoder<R>

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

Attempts to read from the AsyncRead into buf.

impl<R: Debug> Debug for ZstdDecoder<R>

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

Formats the value using the given formatter.

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

where __Origin<'__pin, R>: Unpin,