Struct fuel_data_parser::compression_encoders_and_decoders::ZlibEncoder

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

A zlib 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> ZlibEncoder<W>

where W: AsyncWrite,

pub fn new(inner: W) -> ZlibEncoder<W>

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) -> ZlibEncoder<W>

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

pub fn total_in(&self) -> u64

Returns the total number of input bytes which have been processed by this compression object.

pub fn total_out(&self) -> u64

Returns the total number of output bytes which have been produced by this compression object.

pub fn get_ref(&self) -> &W

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

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

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 ZlibEncoder<W>>) -> Pin<&mut W>

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

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 for ZlibEncoder<W>

where W: AsyncWrite,

fn poll_write( self: Pin<&mut ZlibEncoder<W>>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush( self: Pin<&mut ZlibEncoder<W>>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut ZlibEncoder<W>>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<W> Debug for ZlibEncoder<W>

where W: Debug,

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

Formats the value using the given formatter.

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

where __Origin<'__pin, W>: Unpin,