Struct async_compression::futures::write::ZstdEncoder

pub struct ZstdEncoder<W: AsyncWrite> { /* fields omitted */ }

This is supported on feature="futures-write" and feature="zstd" only.

A zstd encoder, or compressor.

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

Methods

impl<W: AsyncWrite> ZstdEncoder<W>

pub fn new(inner: W, level: i32) -> Self

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

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

The level argument here can range from 1-21. A level of 0 will use zstd's default, which is 3.

pub fn get_ref(&self) -> &W

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

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

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

This is supported on feature="futures-write" 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>

This is supported on feature="futures-write" 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

This is supported on feature="futures-write" 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<'__pin, W: AsyncWrite> Unpin for ZstdEncoder<W> where
    __Origin<'__pin, W>: Unpin, 

impl<W: Debug + AsyncWrite> Debug for ZstdEncoder<W>

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

Formats the value using the given formatter.

impl<W: AsyncWrite> AsyncWrite for ZstdEncoder<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.