Struct actix_web::middleware::Compress

source ·
#[non_exhaustive]
pub struct Compress;
Expand description

Middleware for compressing response payloads.

§Encoding Negotiation

Compress will read the Accept-Encoding header to negotiate which compression codec to use. Payloads are not compressed if the header is not sent. The compress-* feature flags are also considered in this selection process.

§Pre-compressed Payload

If you are serving some data that is already using a compressed representation (e.g., a gzip compressed HTML file from disk) you can signal this to Compress by setting an appropriate Content-Encoding header. In addition to preventing double compressing the payload, this header is required by the spec when using compressed representations and will inform the client that the content should be uncompressed.

However, it is not advised to unconditionally serve encoded representations of content because the client may not support it. The AcceptEncoding typed header has some utilities to help perform manual encoding negotiation, if required. When negotiating content encoding, it is also required by the spec to send a Vary: Accept-Encoding header.

A (naïve) example serving an pre-compressed Gzip file is included below.

§Examples

To enable automatic payload compression just include Compress as a top-level middleware:

use actix_web::{middleware, web, App, HttpResponse};

let app = App::new()
    .wrap(middleware::Compress::default())
    .default_service(web::to(|| async { HttpResponse::Ok().body("hello world") }));

Pre-compressed Gzip file being served from disk with correct headers added to bypass middleware:

use actix_web::{middleware, http::header, web, App, HttpResponse, Responder};

async fn index_handler() -> actix_web::Result<impl Responder> {
    Ok(actix_files::NamedFile::open_async("./assets/index.html.gz").await?
        .customize()
        .insert_header(header::ContentEncoding::Gzip))
}

let app = App::new()
    .wrap(middleware::Compress::default())
    .default_service(web::to(index_handler));

Trait Implementations§

source§

impl Clone for Compress

source§

fn clone(&self) -> Compress

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Compress

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Compress

source§

fn default() -> Compress

Returns the “default value” for a type. Read more
source§

impl<S, B> Transform<S, ServiceRequest> for Compress
where B: MessageBody, S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,

§

type Response = ServiceResponse<EitherBody<Encoder<B>>>

Responses produced by the service.
§

type Error = Error

Errors produced by the service.
§

type Transform = CompressMiddleware<S>

The TransformService value created by this factory
§

type InitError = ()

Errors produced while building a transform service.
§

type Future = Ready<Result<<Compress as Transform<S, ServiceRequest>>::Transform, <Compress as Transform<S, ServiceRequest>>::InitError>>

The future response value.
source§

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more