Struct Config

pub struct Config {
    pub target_output_size: u64,
    pub approx_compr_ratio: f64,
    pub kind: CompressorType,
    pub compression_algo: CompressionAlgo,
}

Available on crate feature protocol only.

Configuration for the compressor itself.

Fields

target_output_size: u64

TargetOutputSize is the target size that the compressed data should reach. The shadow compressor guarantees that the compressed data stays below this bound. The ratio compressor might go over.

approx_compr_ratio: f64

ApproxComprRatio to assume (only ratio compressor). Should be slightly smaller than average from experiments to avoid the chances of creating a small additional leftover frame.

kind: CompressorType

Kind of compressor to use. Must be one of KindKeys. If unset, NewCompressor will default to RatioKind.

compression_algo: CompressionAlgo

Type of compression algorithm to use. Must be one of [zlib, brotli-(9|10|11)]

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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.

impl From<Config> for ShadowCompressor

fn from(config: Config) -> ShadowCompressor

Converts to this type from the input type.