Struct RequestDecompressionLayer

pub struct RequestDecompressionLayer { /* private fields */ }

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

Decompresses request bodies and calls its underlying service.

Transparently decompresses request bodies based on the Content-Encoding header. When the encoding in the Content-Encoding header is not accepted an Unsupported Media Type status code will be returned with the accepted encodings in the Accept-Encoding header.

Enabling pass-through of unaccepted encodings will not return an Unsupported Media Type. But will call the underlying service with the unmodified request if the encoding is not supported. This is disabled by default.

See the module docs for more details.

Implementations

impl RequestDecompressionLayer

pub fn new() -> Self

Creates a new RequestDecompressionLayer.

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

Available on crate feature decompression-gzip only.

Sets whether to support gzip encoding.

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

Available on crate feature decompression-deflate only.

Sets whether to support Deflate encoding.

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

Available on crate feature decompression-br only.

Sets whether to support Brotli encoding.

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

Available on crate feature decompression-zstd only.

Sets whether to support Zstd encoding.

pub fn no_gzip(self) -> Self

Disables support for gzip encoding.

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

pub fn no_deflate(self) -> Self

Disables support for Deflate encoding.

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

pub fn no_br(self) -> Self

Disables support for Brotli encoding.

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

pub fn no_zstd(self) -> Self

Disables support for Zstd encoding.

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

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

Sets whether to pass through the request even when the encoding is not supported.

Trait Implementations

impl Clone for RequestDecompressionLayer

fn clone(&self) -> RequestDecompressionLayer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RequestDecompressionLayer

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

Formats the value using the given formatter.

impl Default for RequestDecompressionLayer

fn default() -> RequestDecompressionLayer

Returns the “default value” for a type.

impl<S> Layer<S> for RequestDecompressionLayer

type Service = RequestDecompression<S>

The wrapped service

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

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