Struct RatioCompressor

pub struct RatioCompressor { /* private fields */ }

Available on crate feature protocol only.

Ratio Compressor

The ratio compressor uses the target size and a compression ration parameter to determine how much data can be written to the compressor before it’s considered full. The full calculation is as follows:

full = uncompressedLength * approxCompRatio >= targetFrameSize * targetNumFrames

The ratio compressor wraps a VariantCompressor which dispatches to the appropriate compression algorithm (ZLIB or Brotli).

Implementations

impl RatioCompressor

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

Create a new RatioCompressor with the given VariantCompressor.

pub fn input_threshold(&self) -> usize

Calculates the input threshold in bytes.

pub fn is_full(&self) -> bool

Returns if the compressor is full (exceeds the input threshold).

Trait Implementations

impl Clone for RatioCompressor

fn clone(&self) -> RatioCompressor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompressorWriter for RatioCompressor

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

Writes the given data to the compressor.

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 len(&self) -> usize

Returns the length of the compressed data.

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 RatioCompressor

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

Formats the value using the given formatter.

impl From<Config> for RatioCompressor

fn from(config: Config) -> RatioCompressor

Converts to this type from the input type.