Struct StreamCompressionLayer 

pub struct StreamCompressionLayer<P = DefaultStreamPredicate> { /* private fields */ }

Available on crate features compression and http 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 StreamCompressionLayer

pub fn new() -> StreamCompressionLayer

Creates a new StreamCompressionLayer.

pub fn with_compress_predicate<C>( self, predicate: C, ) -> StreamCompressionLayer<C>

where C: Predicate,

Replace the current compression predicate.

impl<P> StreamCompressionLayer<P>

pub fn with_gzip(self, enable: bool) -> StreamCompressionLayer<P>

Sets whether to enable the gzip encoding.

pub fn set_gzip(&mut self, enable: bool) -> &mut StreamCompressionLayer<P>

Sets whether to enable the gzip encoding.

pub fn with_deflate(self, enable: bool) -> StreamCompressionLayer<P>

Sets whether to enable the Deflate encoding.

pub fn set_deflate(&mut self, enable: bool) -> &mut StreamCompressionLayer<P>

Sets whether to enable the Deflate encoding.

pub fn with_br(self, enable: bool) -> StreamCompressionLayer<P>

Sets whether to enable the Brotli encoding.

pub fn set_br(&mut self, enable: bool) -> &mut StreamCompressionLayer<P>

Sets whether to enable the Brotli encoding.

pub fn with_zstd(self, enable: bool) -> StreamCompressionLayer<P>

Sets whether to enable the Zstd encoding.

pub fn set_zstd(&mut self, enable: bool) -> &mut StreamCompressionLayer<P>

Sets whether to enable the Zstd encoding.

pub fn with_quality( self, quality: CompressionLevel, ) -> StreamCompressionLayer<P>

Sets the compression quality.

pub fn set_quality( &mut self, quality: CompressionLevel, ) -> &mut StreamCompressionLayer<P>

Sets the compression quality.

pub fn with_enforce_not_acceptable( self, enable: bool, ) -> StreamCompressionLayer<P>

Sets whether to respond with 406 Not Acceptable when the client’s Accept-Encoding header rejects every available representation (e.g. *;q=0 or a lone identity;q=0), as recommended by RFC 9110 §12.5.3.

Enabled by default. Disable to opt out and instead fall back to sending an uncompressed (identity) response regardless of the client’s stated preference.

pub fn set_enforce_not_acceptable( &mut self, enable: bool, ) -> &mut StreamCompressionLayer<P>

Sets whether to respond with 406 Not Acceptable when the client’s Accept-Encoding header rejects every available representation (e.g. *;q=0 or a lone identity;q=0), as recommended by RFC 9110 §12.5.3.

Enabled by default. Disable to opt out and instead fall back to sending an uncompressed (identity) response regardless of the client’s stated preference.

Trait Implementations

impl<P> Clone for StreamCompressionLayer<P>

where P: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P> Debug for StreamCompressionLayer<P>

where P: Debug,

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

Formats the value using the given formatter.

impl<P> Default for StreamCompressionLayer<P>

where P: Default,

fn default() -> StreamCompressionLayer<P>

Returns the “default value” for a type.

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

where P: Predicate,

type Service = StreamCompression<S, P>

The service produced by the layer.

fn layer(&self, inner: S) -> <StreamCompressionLayer<P> as Layer<S>>::Service

Wrap the given service with the middleware, returning a new service.

fn into_layer( self, inner: S, ) -> <StreamCompressionLayer<P> as Layer<S>>::Service

Same as layer but consuming self after the service was created.