Struct ShadowCompressor

pub struct ShadowCompressor { /* private fields */ }

Available on crate feature protocol only.

Shadow Compressor

The shadow compressor contains two compression buffers, one for size estimation, and one for the final compressed data. The first compression buffer is flushed on every write, and the second isn’t, which means the final compressed data is always at least smaller than the size estimation.

One exception to the rule is when the first write to the buffer is not checked against the target. This allows individual blocks larger than the target to be included. Notice, this will be split across multiple channel frames.

Implementations

impl ShadowCompressor

pub const fn new( config: Config, compressor: VariantCompressor, shadow: VariantCompressor, ) -> ShadowCompressor

Creates a new ShadowCompressor with the given VariantCompressor.

Trait Implementations

impl Clone for ShadowCompressor

fn clone(&self) -> ShadowCompressor

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CompressorWriter for ShadowCompressor

fn write(&mut self, data: &[u8]) -> Result<usize, CompressorError>

Writes the given data to the compressor.

fn len(&self) -> usize

Returns the length of the compressed data.

fn flush(&mut self) -> Result<(), CompressorError>

Flushes the buffer.

fn close(&mut self) -> Result<(), CompressorError>

Closes the compressor.

fn reset(&mut self)

Resets the compressor.

fn read(&mut self, buf: &mut [u8]) -> Result<usize, CompressorError>

Reads the compressed data into the given buffer. Returns the number of bytes read.

impl Debug for ShadowCompressor

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

Formats the value using the given formatter.

impl From<Config> for ShadowCompressor

fn from(config: Config) -> ShadowCompressor

Converts to this type from the input type.