Struct CompressMiddlewareBuilder

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

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§

Source§

impl CompressMiddlewareBuilder

Source

pub fn new() -> Self

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

Source

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

Sets the minimum body size threshold value.

Source

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

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

Source

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

Sets the compression level for Brotli.

Source

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

Sets the compression level for both Deflate and Gzip.

Source

pub fn build(self) -> CompressMiddleware

Construct a middleware instance from this builder.

Trait Implementations§

Source§

impl Clone for CompressMiddlewareBuilder

Source§

fn clone(&self) -> CompressMiddlewareBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CompressMiddlewareBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CompressMiddlewareBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<CompressMiddlewareBuilder> for CompressMiddleware

Source§

fn from(builder: CompressMiddlewareBuilder) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,