Struct EncoderParams

pub struct EncoderParams { /* private fields */ }

Available on crate feature brotli only.

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

See the Brotli documentation for more information on these parameters.

Examples

use async_compression::brotli;

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

Implementations

impl EncoderParams

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 0 <= window_size <= 24.

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.

Trait Implementations

impl Clone for EncoderParams

fn clone(&self) -> EncoderParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncoderParams

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

Formats the value using the given formatter.

impl Default for EncoderParams

fn default() -> EncoderParams

Returns the “default value” for a type.

impl PartialEq for EncoderParams

fn eq(&self, other: &EncoderParams) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for EncoderParams

impl Eq for EncoderParams

impl StructuralPartialEq for EncoderParams