Struct Compression 

pub struct Compression { /* private fields */ }

The response compression plugin.

Construct with Compression::new and refine with the builder methods. Also usable as scoped middleware through RouteBuilder::intercept.

Implementations

impl Compression

pub fn new() -> Self

Brotli, then gzip, then deflate, for text-like bodies of at least 1 KiB.

pub fn min_size(self, bytes: usize) -> Self

Only compress buffered bodies of at least bytes.

A streamed body has no length until it ends, so it is always compressed regardless of this setting.

pub fn level(self, level: Level) -> Self

Set how hard the encoder works.

pub fn encodings(self, encodings: impl IntoIterator<Item = Encoding>) -> Self

Restrict and order the codings this server is willing to produce, most preferred first.

Client preference wins on q value; this order only breaks ties. Use it to drop brotli on a CPU-bound service:

use churust_compression::{Compression, Encoding};

let plugin = Compression::new().encodings([Encoding::Gzip]);

Panics

If the list is empty, which would install a plugin that can never do anything.

pub fn compressible<F>(self, f: F) -> Self

where F: Fn(&str) -> bool + Send + Sync + 'static,

Replace the media-type predicate.

use churust_compression::{compressible_by_default, Compression};

// Also compress a bespoke binary format that happens to be repetitive.
let plugin = Compression::new().compressible(|ct| {
    compressible_by_default(ct) || ct.starts_with("application/x-telemetry")
});

Trait Implementations

impl Clone for Compression

fn clone(&self) -> Compression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Compression

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

Formats the value using the given formatter.

impl Default for Compression

fn default() -> Self

Returns the “default value” for a type.

impl Middleware for Compression

fn handle<'life0, 'async_trait>( &'life0 self, call: Call, next: Next, ) -> Pin<Box<dyn Future<Output = Response> + Send + 'async_trait>>

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

Handle the call: optionally inspect/modify it, call next.run(call) to proceed, and return the (possibly post-processed) response.

impl Plugin for Compression

fn install(self: Box<Self>, app: &mut AppBuilder)

Installed in Phase::Plugins. Anything that inspects a response body must sit inside this layer, since outside it the body is compressed.