Struct Compression

pub struct Compression {
    pub level: Level,
    pub excluded_content_types: Vec<MediaType>,
}

Compresses all responses with Brotli or Gzip compression.

Compression is done in the same manner as the Compress responder.

By default, the fairing does not compress responses with a Content-Type matching any of the following:

• application/gzip
• application/zip
• image/*
• video/*
• application/octet-stream
• text/event-stream

Usage

Attach the compression fairing to your Rocket application:

use rocket_async_compression::Compression;


rocket::build()
    // ...
    .attach(Compression::fairing())
    // ...

Fields

level: Level

excluded_content_types: Vec<MediaType>

Implementations

impl Compression

pub fn fairing() -> Compression

Returns a fairing that compresses outgoing requests. Uses default compression level and excluded content types.

Example

To attach this fairing, simply call attach on the application’s Rocket instance with Compression::fairing():

use rocket_async_compression::Compression;

rocket::build()
    // ...
    .attach(Compression::fairing())
    // ...

pub fn with_level(level: Level) -> Compression

Returns a fairing that compresses outgoing requests with the specified compression level.

Example

use rocket_async_compression::{Compression, Level};

rocket::build()
   // ...
   .attach(Compression::with_level(Level::Fastest))
   // ...

pub fn exlude_content_types( self, excluded_content_types: Vec<MediaType>, ) -> Self

Replaces the default list of excluded content types with the provided list.

pub fn excluded_content_types(&mut self) -> &mut Vec<MediaType>

Returns a mutable reference to the list of excluded content types.

Trait Implementations

impl Fairing for Compression

fn info(&self) -> Info

Returns an Info structure containing the name and Kind of this fairing. The name can be any arbitrary string. Kind must be an ord set of Kind variants.

fn on_response<'r, 'life0, 'life1, 'life2, 'async_trait>( &'life0 self, request: &'r Request<'life1>, response: &'life2 mut Response<'r>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'r: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

The response callback.

fn on_ignite<'life0, 'async_trait>( &'life0 self, rocket: Rocket<Build>, ) -> Pin<Box<dyn Future<Output = Result<Rocket<Build>, Rocket<Build>>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

The ignite callback. Returns Ok if ignition should proceed and Err if ignition and launch should be aborted.

fn on_liftoff<'life0, 'life1, 'async_trait>( &'life0 self, _rocket: &'life1 Rocket<Orbit>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

The liftoff callback.

fn on_request<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, _req: &'life1 mut Request<'life2>, _data: &'life3 mut Data<'life4>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, Self: 'async_trait,

The request callback.

fn on_shutdown<'life0, 'life1, 'async_trait>( &'life0 self, _rocket: &'life1 Rocket<Orbit>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

The shutdown callback.