Struct tide_compress::CompressMiddlewareBuilder

pub struct CompressMiddlewareBuilder {
    pub threshold: usize,
    pub content_type_check: Option<Regex>,
    pub brotli_quality: Level,
    pub deflate_quality: Level,
}

Used to create a new CompressMiddleware with custom settings.

Uses the defaults:

• Minimum body size threshold (1024 bytes).
• Check for Content-Type header match ^text/|\+(?:json|text|xml)$ (case insensitive).
• Brotli quality Fastest (level 1).
• Deflate / Gzip quality Default.

Example

let mut app = tide::new();

let check_regex = regex::Regex::new(r"^text/|\+(?:json|text|xml)$").expect("regular expression defined in source code");

let compress_middleware = tide_compress::CompressMiddleware::builder()
    .threshold(1024)
    .content_type_check(Some(check_regex))
    .build();

app.with(compress_middleware);

Fields

threshold: usize

Minimum body size threshold in bytes. Default 1024.

content_type_check: Option<Regex>

Check for Content-Type header match. Default: ^text/|\+(?:json|text|xml)$ (case insensitive).

brotli_quality: Level

Brotli compression quality. Default: Level::Fastest (level 1).

deflate_quality: Level

Deflate / Gzip compression quality. Uses Level::Default.

Implementations

impl CompressMiddlewareBuilder

pub fn new() -> Self

Make a new builder. Identical to CompressMiddleware::builder().

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

Sets the minimum body size threshold value.

pub fn content_type_check(self, content_type_check: Option<Regex>) -> Self

Sets the Content-Type header (MIME) check regular expression.

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

Sets the compression level for Brotli.

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

Sets the compression level for both Deflate and Gzip.

pub fn build(self) -> CompressMiddleware

Construct a middleware instance from this builder.

Trait Implementations

impl Clone for CompressMiddlewareBuilder

fn clone(&self) -> CompressMiddlewareBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompressMiddlewareBuilder

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

Formats the value using the given formatter.

impl Default for CompressMiddlewareBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<CompressMiddlewareBuilder> for CompressMiddleware

fn from(builder: CompressMiddlewareBuilder) -> Self

Converts to this type from the input type.