Struct XzEncoder 

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

Available on crate feature xz only.

A xz encoder, or compressor.

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

Implementations

impl<W: AsyncWrite> XzEncoder<W>

pub fn new(inner: W) -> Self

Available on crate feature futures-io only.

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

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

Available on crate feature futures-io only.

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

pub fn get_ref(&self) -> &W

Available on crate feature futures-io only.

Acquires a reference to the underlying writer that this encoder is wrapping.

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

Available on crate feature futures-io only.

Acquires a mutable reference to the underlying writer that this encoder is wrapping.

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

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

Available on crate feature futures-io only.

Acquires a pinned mutable reference to the underlying writer that this encoder is wrapping.

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

pub fn into_inner(self) -> W

Available on crate feature futures-io only.

Consumes this encoder returning the underlying writer.

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<W: AsyncWrite> AsyncWrite for XzEncoder<W>

Available on crate feature futures-io only.

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 XzEncoder<W>

Available on crate feature futures-io only.

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

Formats the value using the given formatter.

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

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

Available on crate feature futures-io only.