http-response-compression 0.1.4

Tower middleware for compressing HTTP response bodies
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

# http-response-compression

[![Build status](https://github.com/bouk/http-response-compression/workflows/Test/badge.svg)](https://github.com/bouk/http-response-compression/actions)
[![Crates.io](https://img.shields.io/crates/v/http-response-compression)](https://crates.io/crates/http-response-compression)
[![Documentation](https://docs.rs/http-response-compression/badge.svg)](https://docs.rs/http-response-compression)
[![License](https://img.shields.io/crates/l/http-response-compression)](LICENSE)

A Tower middleware layer for compressing HTTP response bodies.

## Features

- Supports Zstd, Brotli, Gzip, and Deflate compression
- Automatic codec selection based on `Accept-Encoding` header
- Configurable minimum body size threshold (default: 860 bytes)
- Streaming support with flush control for SSE and gRPC-web
- Preserves trailers through compression

## Usage

```rust
use http_response_compression::CompressionLayer;
use tower::ServiceBuilder;

let service = ServiceBuilder::new()
    .layer(CompressionLayer::new())
    .service(my_service);
```

With custom minimum size:

```rust
let service = ServiceBuilder::new()
    .layer(CompressionLayer::new().min_size(1024))
    .service(my_service);
```

## Compression Rules

The middleware will **not** compress responses when:

- No supported `Accept-Encoding` is present in the request
- `Content-Encoding` header is already set
- `Content-Range` header is present (range responses)
- `Content-Type` is `image/*` (except `image/svg+xml`)
- `Content-Type` is `application/grpc` (except `application/grpc-web`)
- `Content-Length` is below the minimum size threshold

The middleware will **always flush** after each chunk when:

- `X-Accel-Buffering: no` header is present
- `Content-Type` is `text/event-stream`
- `Content-Type` is `application/grpc-web`

## Response Modifications

When compression is applied:

- `Content-Encoding` header is set to the codec used
- `Content-Length` header is removed (compressed size is unknown)
- `Accept-Ranges` header is removed
- `Vary` header includes `Accept-Encoding`

## License

MIT