Struct RequestDecompression

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

Available on crate feature compression 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 into_inner(self) -> S

Consumes self, returning the underlying service.

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 set_pass_through_unaccepted(&mut self, enabled: bool) -> &mut 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

Sets whether to support gzip encoding.

pub fn set_gzip(&mut self, enable: bool) -> &mut Self

Sets whether to support gzip encoding.

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

Sets whether to support Deflate encoding.

pub fn set_deflate(&mut self, enable: bool) -> &mut Self

Sets whether to support Deflate encoding.

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

Sets whether to support Brotli encoding.

pub fn set_br(&mut self, enable: bool) -> &mut Self

Sets whether to support Brotli encoding.

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

Sets whether to support Zstd encoding.

pub fn set_zstd(&mut self, enable: bool) -> &mut Self

Sets whether to support Zstd encoding.

Trait Implementations

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

fn clone(&self) -> Self

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, State, ReqBody, ResBody, D> Service<State, Request<ReqBody>> for RequestDecompression<S>

where S: Service<State, Request<DecompressionBody<ReqBody>>, Response = Response<ResBody>, Error: Into<BoxError>>, State: Clone + Send + Sync + 'static, ReqBody: Body + Send + 'static, ResBody: Body<Data = D, Error: Into<BoxError>> + Send + 'static, 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<Self::Response, Self::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.