Struct tower_http::decompression::Decompression

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

Available on crate features decompression-br or decompression-deflate or decompression-gzip or decompression-zstd 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.

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() -> DecompressionLayer

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

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

Available on crate feature decompression-gzip only.

Sets whether to request the gzip encoding.

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

Available on crate feature decompression-deflate only.

Sets whether to request the Deflate encoding.

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

Available on crate feature decompression-br only.

Sets whether to request the Brotli encoding.

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

Available on crate feature decompression-zstd only.

Sets whether to request the Zstd encoding.

pub fn no_gzip(self) -> Self

Disables the gzip encoding.

This method is available even if the gzip crate feature is disabled.

pub fn no_deflate(self) -> Self

Disables the Deflate encoding.

This method is available even if the deflate crate feature is disabled.

pub fn no_br(self) -> Self

Disables the Brotli encoding.

This method is available even if the br crate feature is disabled.

pub fn no_zstd(self) -> Self

Disables the Zstd encoding.

This method is available even if the zstd crate feature is disabled.

Trait Implementations

impl<S: Clone> Clone for Decompression<S>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

where S: Service<Request<ReqBody>, Response = Response<ResBody>>, ResBody: Body,

type Response = Response<DecompressionBody<ResBody>>

Responses given by the service.

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

Errors produced by the service.

type Future = ResponseFuture<<S as Service<Request<ReqBody>>>::Future>

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.