Struct Decompression 

pub struct Decompression<S, 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<S> Decompression<S>

pub fn new(service: S) -> Self

Creates a new Decompression wrapping the service.

impl<S, M> Decompression<S, M>

pub fn get_ref(&self) -> &S

Gets a reference to the underlying service.

pub fn into_inner(self) -> S

Consumes self, returning the underlying service.

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

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

When disabled, the request header is forwarded as-is and the layer only advertises supported encodings if the request already contains an Accept-Encoding header.

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.

When disabled, the request header is forwarded as-is and the layer only advertises supported encodings if the request already contains an Accept-Encoding header.

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

Replaces the request/response decompression matcher.

The matcher runs at request time and may select a second matcher to evaluate the response after the inner service returns. If no response matcher is selected or if the selected response matcher does not match, the response is left compressed even when Rama supports decompressing it.

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.

For relays that decode → modify → re-encode a response (e.g. a MITM HTML rewriter): a truncated upstream body yields a short-but-well-formed client stream rather than an aborted one (RST_STREAM). Off by default; genuine upstream transport errors still propagate.

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.

For relays that decode → modify → re-encode a response (e.g. a MITM HTML rewriter): a truncated upstream body yields a short-but-well-formed client stream rather than an aborted one (RST_STREAM). Off by default; genuine upstream transport errors still propagate.

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<S: Clone, M: Clone> Clone for Decompression<S, M>

fn clone(&self) -> Decompression<S, M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug, M: Debug> Debug for Decompression<S, M>

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

Formats the value using the given formatter.

impl<S, M, ReqBody, ResBody> Service<Request<ReqBody>> for Decompression<S, M>

where S: Service<Request<ReqBody>, Output = Response<ResBody>, Error: Into<BoxError>>, M: ServiceMatcher<Request<ReqBody>, ModifiedInput = Request<ReqBody>, Service: ServiceMatcher<Response<ResBody>, ModifiedInput = Response<ResBody>, Service = (), Error: Into<BoxError>>, Error: Into<BoxError>>, ReqBody: Send + 'static, ResBody: StreamingBody<Data: Send + 'static, Error: Send + 'static> + Send + 'static,

type Output = Response<DecompressionBody<ResBody>>

The type of the output returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, req: Request<ReqBody>, ) -> Result<Self::Output, Self::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.