Struct CompressionLayer

pub struct CompressionLayer<P = DefaultPredicate> { /* private fields */ }

Available on crate features compression-br or compression-deflate or compression-gzip or compression-zstd only.

Compress response bodies of the underlying service.

This uses the Accept-Encoding header to pick an appropriate encoding and adds the Content-Encoding header to responses.

See the module docs for more details.

Implementations

impl CompressionLayer

pub fn new() -> Self

Creates a new CompressionLayer.

pub fn gzip(self, enable: bool) -> Self

Available on crate feature compression-gzip only.

Sets whether to enable the gzip encoding.

pub fn deflate(self, enable: bool) -> Self

Available on crate feature compression-deflate only.

Sets whether to enable the Deflate encoding.

pub fn br(self, enable: bool) -> Self

Available on crate feature compression-br only.

Sets whether to enable the Brotli encoding.

pub fn zstd(self, enable: bool) -> Self

Available on crate feature compression-zstd only.

Sets whether to enable the Zstd encoding.

pub fn quality(self, quality: CompressionLevel) -> Self

Sets the compression quality.

pub fn no_gzip(self) -> Self

Disables the gzip encoding.

This method is available even if the gzip crate feature is disabled.

pub fn no_deflate(self) -> Self

Disables the Deflate encoding.

This method is available even if the deflate crate feature is disabled.

pub fn no_br(self) -> Self

Disables the Brotli encoding.

This method is available even if the br crate feature is disabled.

pub fn no_zstd(self) -> Self

Disables the Zstd encoding.

This method is available even if the zstd crate feature is disabled.

pub fn compress_when<C>(self, predicate: C) -> CompressionLayer<C>

where C: Predicate,

Replace the current compression predicate.

See Compression::compress_when for more details.

Trait Implementations

impl<P: Clone> Clone for CompressionLayer<P>

fn clone(&self) -> CompressionLayer<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug> Debug for CompressionLayer<P>

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

Formats the value using the given formatter.

impl<P: Default> Default for CompressionLayer<P>

fn default() -> CompressionLayer<P>

Returns the “default value” for a type.

impl<S, P> Layer<S> for CompressionLayer<P>

where P: Predicate,

type Service = Compression<S, P>

The wrapped service

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.