Struct Compression 

pub struct Compression<S, P = DefaultPredicate> { /* private fields */ }

Available on crate feature compression only.

Compress response bodies of the underlying service.

This uses the Accept-Encoding header to pick an appropriate encoding and adds the Content-Encoding header to responses.

See the module docs for more details.

Implementations

impl<S> Compression<S, DefaultPredicate>

pub fn new(service: S) -> Self

Creates a new Compression wrapping the service.

impl<S, P> Compression<S, P>

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

Sets whether to enable the gzip encoding.

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

Sets whether to enable the gzip encoding.

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

Sets whether to enable the Deflate encoding.

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

Sets whether to enable the Deflate encoding.

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

Sets whether to enable the Brotli encoding.

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

Sets whether to enable the Brotli encoding.

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

Sets whether to enable the Zstd encoding.

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

Sets whether to enable the Zstd encoding.

pub fn with_quality(self, quality: CompressionLevel) -> Self

Sets the compression quality.

pub fn set_quality(&mut self, quality: CompressionLevel) -> &mut Self

Sets the compression quality.

pub fn with_respect_content_encoding_if_possible(self) -> Self

Allow responses with content-encoding.

Useful in case your stack uses that response header as preference. Not something you want for regular servers or proxies however, or most use cases for that matter.

pub fn set_respect_content_encoding_if_possible(&mut self) -> &mut Self

Allow responses with content-encoding.

Useful in case your stack uses that response header as preference. Not something you want for regular servers or proxies however, or most use cases for that matter.

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

Sets whether to respond with 406 Not Acceptable when the client’s Accept-Encoding header rejects every available representation (e.g. *;q=0 or a lone identity;q=0), as recommended by RFC 9110 §12.5.3.

Enabled by default. Disable to opt out and instead fall back to sending an uncompressed (identity) response regardless of the client’s stated preference.

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

Sets whether to respond with 406 Not Acceptable when the client’s Accept-Encoding header rejects every available representation (e.g. *;q=0 or a lone identity;q=0), as recommended by RFC 9110 §12.5.3.

Enabled by default. Disable to opt out and instead fall back to sending an uncompressed (identity) response regardless of the client’s stated preference.

pub fn with_compress_predicate<C>(self, predicate: C) -> Compression<S, C>

where C: Predicate,

Replace the current compression predicate.

Predicates are used to determine whether a response should be compressed or not.

The default predicate is DefaultPredicate. See its documentation for more details on which responses it won’t compress.

Changing the compression predicate

use rama_utils::str::arcstr::arcstr;
use rama_http::layer::compression::{
    Compression,
    predicate::{Predicate, NotForContentType, DefaultPredicate},
};
use rama_core::service::service_fn;

// Placeholder service_fn
let service = service_fn(async |_: ()| {
    Ok::<_, std::io::Error>(rama_http::Response::new(()))
});

// build our custom compression predicate
// its recommended to still include `DefaultPredicate` as part of
// custom predicates
let predicate = DefaultPredicate::new()
    // don't compress responses who's `content-type` starts with `application/json`
    .and(NotForContentType::new(arcstr!("application/json")));

let service = Compression::new(service).with_compress_predicate(predicate);

See predicate for more utilities for building compression predicates.

Responses that are already compressed (ie have a content-encoding header) will never be recompressed, regardless what they predicate says.

Trait Implementations

impl<S: Clone, P: Clone> Clone for Compression<S, P>

fn clone(&self) -> Compression<S, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug, P: Debug> Debug for Compression<S, P>

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

Formats the value using the given formatter.

impl<ReqBody, ResBody, S, P> Service<Request<ReqBody>> for Compression<S, P>

where S: Service<Request<ReqBody>, Output = Response<ResBody>>, ResBody: StreamingBody<Data: Send + 'static, Error: Send + 'static> + Send + 'static, P: Predicate + Send + Sync + 'static, ReqBody: Send + 'static,

type Output = Response<CompressionBody<ResBody>>

The type of the output returned by the service.

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

The type of error returned by the service.

async fn serve( &self, req: Request<ReqBody>, ) -> Result<Self::Output, Self::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.