Struct tower_http::decompression::RequestDecompression

pub struct RequestDecompression<S> { /* 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<S> RequestDecompression<S>

pub fn new(service: S) -> Self

Creates a new RequestDecompression wrapping the service.

pub fn get_ref(&self) -> &S

Gets a reference to the underlying service.

pub fn get_mut(&mut self) -> &mut S

Gets a mutable reference to the underlying service.

pub fn into_inner(self) -> S

Consumes self, returning the underlying service.

pub fn layer() -> RequestDecompressionLayer

Returns a new Layer that wraps services with a RequestDecompression middleware.

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

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

By default pass-through is disabled.

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.

Trait Implementations

impl<S: Clone> Clone for RequestDecompression<S>

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

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

Formats the value using the given formatter.

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

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

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

Responses given by the service.

type Error = <S as Service<Request<DecompressionBody<ReqBody>>>>::Error

Errors produced by the service.

type Future = RequestDecompressionFuture<<S as Service<Request<DecompressionBody<ReqBody>>>>::Future, ResBody, <S as Service<Request<DecompressionBody<ReqBody>>>>::Error>

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<ReqBody>) -> Self::Future

Process the request and return the response asynchronously.