Struct rama::http::layer::decompression::RequestDecompression

pub struct RequestDecompression<S> { /* private fields */ }

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<S> RequestDecompression<S>

pub fn new(service: S) -> RequestDecompression<S>

Creates a new RequestDecompression wrapping the service.

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 pass_through_unaccepted(self, enabled: bool) -> RequestDecompression<S>

Passes through the request even when the encoding is not supported.

By default pass-through is disabled.

pub fn set_pass_through_unaccepted( &mut self, enabled: bool, ) -> &mut RequestDecompression<S>

Passes through the request even when the encoding is not supported.

By default pass-through is disabled.

pub fn gzip(self, enable: bool) -> RequestDecompression<S>

Sets whether to support gzip encoding.

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

Sets whether to support gzip encoding.

pub fn deflate(self, enable: bool) -> RequestDecompression<S>

Sets whether to support Deflate encoding.

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

Sets whether to support Deflate encoding.

pub fn br(self, enable: bool) -> RequestDecompression<S>

Sets whether to support Brotli encoding.

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

Sets whether to support Brotli encoding.

pub fn zstd(self, enable: bool) -> RequestDecompression<S>

Sets whether to support Zstd encoding.

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

Sets whether to support Zstd encoding.

Trait Implementations

impl<S> Clone for RequestDecompression<S>

where S: Clone,

fn clone(&self) -> RequestDecompression<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for RequestDecompression<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<S, State, ReqBody, ResBody, D> Service<State, Request<ReqBody>> for RequestDecompression<S>

where S: Service<State, Request<DecompressionBody<ReqBody>>, Response = Response<ResBody>>, <S as Service<State, Request<DecompressionBody<ReqBody>>>>::Error: Into<Box<dyn Error + Send + Sync>>, State: Send + Sync + 'static, ReqBody: Body + Send + 'static, ResBody: Body<Data = D> + Send + 'static, <ResBody as Body>::Error: Into<Box<dyn Error + Send + Sync>>, D: Buf + 'static,

type Response = Response<UnsyncBoxBody<D, Box<dyn Error + Send + Sync>>>

The type of response returned by the service.

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

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<ReqBody>, ) -> Result<<RequestDecompression<S> as Service<State, Request<ReqBody>>>::Response, <RequestDecompression<S> as Service<State, Request<ReqBody>>>::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.