Struct CompressMiddleware

pub struct CompressMiddleware { /* private fields */ }

A middleware for compressing response body data.

Example

let mut app = tide::new();

app.with(tide_compress::CompressMiddleware::new());

Implementations

impl CompressMiddleware

pub fn new() -> Self

Creates a new CompressMiddleware.

Uses the defaults:

• Minimum body size threshold (1024 bytes).
• Check for Content-Type header match ^text/|\+(?:json|text|xml)$ (case insensitive).

Example

let mut app = tide::new();

app.with(tide_compress::CompressMiddleware::new());

pub fn builder() -> CompressMiddlewareBuilder

Used to create a new CompressMiddleware with custom settings.

See CompressMiddlewareBuilder

pub fn set_threshold(&mut self, threshold: usize)

Sets the minimum body size threshold value.

pub fn threshold(&self) -> usize

Gets the existing minimum body size threshold value.

pub fn set_content_type_check(&mut self, content_type_check: Option<Regex>)

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

pub fn content_type_check(&self) -> Option<&Regex>

Gets a reference to the existing Content-Type header (MIME) check regular expression.

Trait Implementations

impl Clone for CompressMiddleware

fn clone(&self) -> CompressMiddleware

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompressMiddleware

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

Formats the value using the given formatter.

impl Default for CompressMiddleware

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.

impl<State: Clone + Send + Sync + 'static> Middleware<State> for CompressMiddleware

fn handle<'life0, 'life1, 'async_trait>( &'life0 self, req: Request<State>, next: Next<'life1, State>, ) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Asynchronously handle the request, and return a response.

fn name(&self) -> &str

Set the middleware’s name. By default it uses the type signature.