Struct Decompression 

pub struct Decompression<S, M = DefaultDecompressionMatcher> { /* private fields */ }

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) -> Decompression<S>

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, ) -> Decompression<S, M>

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

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_gzip(self, enable: bool) -> Decompression<S, M>

Sets whether to request the gzip encoding.

pub fn set_gzip(&mut self, enable: bool) -> &mut Decompression<S, M>

Sets whether to request the gzip encoding.

pub fn with_deflate(self, enable: bool) -> Decompression<S, M>

Sets whether to request the Deflate encoding.

pub fn set_deflate(&mut self, enable: bool) -> &mut Decompression<S, M>

Sets whether to request the Deflate encoding.

pub fn with_br(self, enable: bool) -> Decompression<S, M>

Sets whether to request the Brotli encoding.

pub fn set_br(&mut self, enable: bool) -> &mut Decompression<S, M>

Sets whether to request the Brotli encoding.

pub fn with_zstd(self, enable: bool) -> Decompression<S, M>

Sets whether to request the Zstd encoding.

pub fn set_zstd(&mut self, enable: bool) -> &mut Decompression<S, M>

Sets whether to request the Zstd encoding.

Trait Implementations

impl<S, M> Clone for Decompression<S, M>

where S: Clone, M: Clone,

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

where S: Debug, M: Debug,

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

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>>, <S as Service<Request<ReqBody>>>::Error: Into<Box<dyn Error + Sync + Send>>, M: ServiceMatcher<Request<ReqBody>, ModifiedInput = Request<ReqBody>>, <M as ServiceMatcher<Request<ReqBody>>>::Service: ServiceMatcher<Response<ResBody>, ModifiedInput = Response<ResBody>, Service = ()>, <<M as ServiceMatcher<Request<ReqBody>>>::Service as ServiceMatcher<Response<ResBody>>>::Error: Into<Box<dyn Error + Sync + Send>>, <M as ServiceMatcher<Request<ReqBody>>>::Error: Into<Box<dyn Error + Sync + Send>>, ReqBody: Send + 'static, ResBody: Body + Send + 'static, <ResBody as Body>::Data: Send + 'static, <ResBody as Body>::Error: 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<<Decompression<S, M> as Service<Request<ReqBody>>>::Output, <Decompression<S, M> as Service<Request<ReqBody>>>::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.