Struct async_compression::futures::bufread::XzEncoder

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

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

A xz encoder, or compressor.

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

Methods

impl<R: AsyncBufRead> XzEncoder<R>

pub fn new(inner: R) -> Self

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

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

pub fn with_quality(inner: R, level: Level) -> Self

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

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

pub fn get_ref(&self) -> &R

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

Acquires a reference to the underlying reader that this encoder 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 encoder is wrapping.

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

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 encoder is wrapping.

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

pub fn into_inner(self) -> R

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

Consumes this encoder returning the underlying reader.

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

Trait Implementations

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

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

Formats the value using the given formatter.

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