Struct Compression 

pub struct Compression { /* private fields */ }

Response compression with gzip (compress-lib), for deployments where nothing in front compresses.

Compression together with secrets and reflected input in one page can leak the secrets (BREACH). csrf-sec masks its tokens per response, which is the defence for them; other secrets in compressed pages are the application’s to consider.

use web_net::{App, Compression, get};

let app = App::builder()
    .compress(Compression::default().min_bytes(512).level(6))
    .route(get("/", |cx| cx.text(200, &"hello ".repeat(200))))
    .build()?;
let r = serve_net::testing::respond(
    &app,
    b"GET / HTTP/1.1\r\nHost: localhost\r\nAccept-Encoding: gzip\r\n\r\n",
);
assert_eq!(r.header("content-encoding"), Some(&b"gzip"[..]));

Implementations

impl Compression

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

Bodies smaller than this are sent as they are (default 1024).

use web_net::{App, Compression, get};

// A 600-byte page is under the minimum, so it goes out as it is.
let app = App::builder()
    .compress(Compression::default().min_bytes(4096))
    .route(get("/", |cx| cx.text(200, &"hello ".repeat(100))))
    .build()?;
let r = serve_net::testing::respond(
    &app,
    b"GET / HTTP/1.1\r\nHost: localhost\r\nAccept-Encoding: gzip\r\n\r\n",
);
assert_eq!(r.header("content-encoding"), None);

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

The level, 1 (fastest) to 9 (smallest); default 6.

use web_net::{App, Compression, get};

// Fastest; values outside 1 to 9 are clamped.
let app = App::builder()
    .compress(Compression::default().level(1))
    .route(get("/", |cx| cx.text(200, &"hello ".repeat(400))))
    .build()?;
let r = serve_net::testing::respond(
    &app,
    b"GET / HTTP/1.1\r\nHost: localhost\r\nAccept-Encoding: gzip\r\n\r\n",
);
assert_eq!(r.header("content-encoding"), Some(&b"gzip"[..]));

Trait Implementations

impl Clone for Compression

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Compression

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 Eq for Compression

impl PartialEq for Compression

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Compression