Struct Compression 

#[non_exhaustive]
pub struct Compression {
    pub algos: IndexMap<CompressionAlgo, CompressionLevel>,
    pub content_types: Vec<Mime>,
    pub min_length: usize,
    pub force_priority: bool,
}

Compression

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

algos: IndexMap<CompressionAlgo, CompressionLevel>

Compression algorithms to use.

content_types: Vec<Mime>

Content types to compress.

min_length: usize

Minimum body size to compress; bodies smaller than this value are not compressed.

This threshold only applies to bodies whose length is known up front (in-memory Once/Chunks bodies). Streaming bodies (Hyper/Stream) have no known length and are always compressed regardless of min_length, so a tiny streamed body can still end up larger after adding Content-Encoding and framing overhead.

force_priority: bool

Ignore the client’s algorithm order in Accept-Encoding and always use the server’s configured priority.

Implementations

impl Compression

pub fn new() -> Self

Create a new Compression.

pub fn disable_all(self) -> Self

Remove all compression algorithms.

pub fn enable_gzip(self, level: CompressionLevel) -> Self

Available on crate feature gzip only.

Sets Compression with algos.

pub fn disable_gzip(self) -> Self

Available on crate feature gzip only.

Disable gzip compression.

pub fn enable_zstd(self, level: CompressionLevel) -> Self

Available on crate feature zstd only.

Enable zstd compression.

pub fn disable_zstd(self) -> Self

Available on crate feature zstd only.

Disable zstd compression.

pub fn enable_brotli(self, level: CompressionLevel) -> Self

Available on crate feature brotli only.

Enable brotli compression.

pub fn disable_brotli(self) -> Self

Available on crate feature brotli only.

Disable brotli compression.

pub fn enable_deflate(self, level: CompressionLevel) -> Self

Available on crate feature deflate only.

Enable deflate compression.

pub fn disable_deflate(self) -> Self

Available on crate feature deflate only.

Disable deflate compression.

pub fn min_length(self, size: usize) -> Self

Sets minimum compression size, if body is less than this value, no compression. Default is 1kb.

Only effective for bodies with a known length (Once/Chunks); streaming bodies (Hyper/Stream) are always compressed regardless of this value.

pub fn force_priority(self, force_priority: bool) -> Self

Sets Compression with force_priority.

pub fn content_types(self, content_types: &[Mime]) -> Self

Sets Compression with content types list.

Trait Implementations

impl Clone for Compression

fn clone(&self) -> Compression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Compression

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

Formats the value using the given formatter.

impl Default for Compression

fn default() -> Self

Returns the “default value” for a type.

impl Handler for Compression

fn handle<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, req: &'life1 mut Request, depot: &'life2 mut Depot, res: &'life3 mut Response, ctrl: &'life4 mut FlowCtrl, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait,

Handles one HTTP request.

fn arc(self) -> ArcHandler

where Self: Sized,

Wrap to ArcHandler.

fn hooped(self) -> HoopedHandler

where Self: Sized,

Wraps this handler in a HoopedHandler.

fn hoop<H>(self, hoop: H) -> HoopedHandler

where H: Handler, Self: Sized,

Hoop this handler with middleware.

fn hoop_when<H, F>(self, hoop: H, filter: F) -> HoopedHandler

where Self: Sized, H: Handler, F: Fn(&Request, &Depot) -> bool + Send + Sync + 'static,

Hoop this handler with middleware.