Struct DecompressionLayer 

pub struct DecompressionLayer<M = DefaultDecompressionMatcher> { /* private fields */ }

Available on crate feature compression only.

Decompresses response bodies of the underlying service.

This adds the Accept-Encoding header to requests and transparently decompresses response bodies based on the Content-Encoding header.

See the module docs for more details.

Implementations

impl DecompressionLayer

pub fn new() -> Self

Creates a new DecompressionLayer.

impl<M> DecompressionLayer<M>

pub fn with_insert_accept_encoding_header(self, insert: bool) -> Self

Sets whether the layer inserts Accept-Encoding into requests when it is absent.

By default it is true.

pub fn set_insert_accept_encoding_header(&mut self, insert: bool) -> &mut Self

Sets whether the layer inserts Accept-Encoding into requests when it is absent.

By default it is true.

pub fn with_matcher<T>(self, matcher: T) -> DecompressionLayer<T>

Replaces the request/response decompression matcher.

The default matcher DefaultDecompressionMatcher matches any response which has a response payload to be decompressed.

pub fn with_tolerate_decode_errors(self, tolerate: bool) -> Self

End a response body cleanly on a mid-stream decode error (after some data decoded) instead of surfacing the error. Off by default.

Intended for relays that decode → modify → re-encode a response (e.g. a MITM HTML rewriter): a truncated upstream body then yields a short-but- well-formed client stream rather than an aborted one.

pub fn set_tolerate_decode_errors(&mut self, tolerate: bool) -> &mut Self

End a response body cleanly on a mid-stream decode error (after some data decoded) instead of surfacing the error. Off by default.

Intended for relays that decode → modify → re-encode a response (e.g. a MITM HTML rewriter): a truncated upstream body then yields a short-but- well-formed client stream rather than an aborted one.

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

Sets whether to request the gzip encoding.

pub fn set_gzip(&mut self, enable: bool) -> &mut Self

Sets whether to request the gzip encoding.

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

Sets whether to request the Deflate encoding.

pub fn set_deflate(&mut self, enable: bool) -> &mut Self

Sets whether to request the Deflate encoding.

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

Sets whether to request the Brotli encoding.

pub fn set_br(&mut self, enable: bool) -> &mut Self

Sets whether to request the Brotli encoding.

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

Sets whether to request the Zstd encoding.

pub fn set_zstd(&mut self, enable: bool) -> &mut Self

Sets whether to request the Zstd encoding.

Trait Implementations

impl<M: Clone> Clone for DecompressionLayer<M>

fn clone(&self) -> DecompressionLayer<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for DecompressionLayer<M>

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

Formats the value using the given formatter.

impl<M: Default> Default for DecompressionLayer<M>

fn default() -> Self

Returns the “default value” for a type.

impl<S, M> Layer<S> for DecompressionLayer<M>

where M: Clone,

type Service = Decompression<S, M>

The service produced by the layer.

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

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

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

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