Struct async_compression::futures::bufread::XzDecoder

pub struct XzDecoder<R> { /* fields omitted */ }

This is supported on feature="futures-bufread" and feature="xz" only.

A xz 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> XzDecoder<R>

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

This is supported on feature="futures-bufread" only.

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

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

This is supported on feature="futures-bufread" only.

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

This is supported on feature="futures-bufread" only.

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

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

This is supported on feature="futures-bufread" only.

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>

This is supported on feature="futures-bufread" only.

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

This is supported on feature="futures-bufread" only.

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

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, Error>>

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

impl<R: Debug> Debug for XzDecoder<R>

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

Formats the value using the given formatter.

impl<'__pin, R> Unpin for XzDecoder<R> where
    __Origin<'__pin, R>: Unpin,