Struct EncoderParams 

pub struct EncoderParams { /* private fields */ }

Available on async_compression_unstable and crate feature brotli-mbrotli only.

Brotli compression parameters builder for the mbrotli backend. This is a stable wrapper around mbrotli’s own encoder configuration, to abstract over different versions of the mbrotli library.

The builder methods mirror brotli::params::EncoderParams where the two backends overlap, so switching between them only needs a type change.

See the Brotli documentation for more information on these parameters.

Examples

use compression_codecs::mbrotli;

let params = mbrotli::params::EncoderParams::default()
    .window_size(12)
    .text_mode();

Implementations

impl EncoderParams

pub fn quality(self, level: Level) -> Self

pub fn window_size(self, window_size: i32) -> Self

Sets window size in bytes (as a power of two).

Used as Brotli’s lgwin parameter.

window_size is clamped to 10 <= window_size <= 24, except 0 which selects the default window, as the brotli backend does.

pub fn block_size(self, block_size: i32) -> Self

Sets input block size in bytes (as a power of two).

Used as Brotli’s lgblock parameter.

block_size is clamped to 16 <= block_size <= 24.

pub fn size_hint(self, size_hint: usize) -> Self

Sets hint for size of data to be compressed.

pub fn text_mode(self) -> Self

Sets encoder to text mode.

If input data is known to be UTF-8 text, this allows the compressor to make assumptions and optimizations.

Used as Brotli’s mode parameter.

pub fn font_mode(self) -> Self

Sets encoder to font mode.

Tunes the compressor for WOFF 2.0 font data.

Used as Brotli’s mode parameter.

Trait Implementations

impl Clone for EncoderParams

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EncoderParams

impl Debug for EncoderParams

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

Formats the value using the given formatter.

impl Default for EncoderParams

fn default() -> Self

Returns the “default value” for a type.