Struct CompressionBuilder 

pub struct CompressionBuilder(/* private fields */);

Available on crate feature plugins only.

Builder for configuring HTTP response compression settings.

CompressionBuilder provides a fluent API for constructing compression plugin configurations. It allows selective enabling/disabling of compression algorithms, setting compression levels, and configuring behavior options like streaming and minimum response size thresholds.

Examples

use tako::plugins::compression::CompressionBuilder;

// Basic setup with default settings
let basic = CompressionBuilder::new().build();

// Custom configuration
let custom = CompressionBuilder::new()
    .enable_gzip(true)
    .gzip_level(8)
    .enable_brotli(true)
    .brotli_level(6)
    .enable_deflate(false)
    .min_size(2048)
    .enable_stream(true)
    .build();

Implementations

impl CompressionBuilder

pub fn new() -> CompressionBuilder

Creates a new compression configuration builder with default settings.

pub fn enable_gzip(self, yes: bool) -> CompressionBuilder

Enables or disables Gzip compression.

pub fn enable_brotli(self, yes: bool) -> CompressionBuilder

Enables or disables Brotli compression.

pub fn enable_deflate(self, yes: bool) -> CompressionBuilder

Enables or disables DEFLATE compression.

pub fn enable_zstd(self, yes: bool) -> CompressionBuilder

Available on crate feature zstd only.

Enables or disables Zstandard compression (requires zstd feature).

pub fn enable_stream(self, stream: bool) -> CompressionBuilder

Enables or disables streaming compression mode.

pub fn min_size(self, bytes: usize) -> CompressionBuilder

Sets the minimum response size threshold for compression.

pub fn content_types(self, policy: ContentTypePolicy) -> CompressionBuilder

Replaces the content-type matching policy.

pub fn gzip_level(self, lvl: u32) -> CompressionBuilder

Sets the Gzip compression level (1-9).

pub fn brotli_level(self, lvl: u32) -> CompressionBuilder

Sets the Brotli compression level (1-11).

pub fn deflate_level(self, lvl: u32) -> CompressionBuilder

Sets the DEFLATE compression level (1-9).

pub fn zstd_level(self, lvl: i32) -> CompressionBuilder

Available on crate feature zstd only.

Sets the Zstandard compression level (1-22, requires zstd feature).

pub fn protect_sensitive(self, on: bool) -> CompressionBuilder

Toggle the CRIME/BREACH mitigation. Default is true: responses containing Set-Cookie, or whose request carried Authorization, Proxy-Authorization, or Cookie, are sent uncompressed. Setting this to false re-enables compression unconditionally — only do so if you have an alternative mitigation (per-response padding, rotated tokens).

pub fn build(self) -> CompressionPlugin

Builds the compression plugin with the configured settings.

Trait Implementations

impl Default for CompressionBuilder

fn default() -> CompressionBuilder

Returns the “default value” for a type.