trillium-static-compiled 0.7.0

compile-time static assets for trillium.rs
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

# 📦 trillium-static-compiled — embedded static file serving

[![ci][ci-badge]][ci]
[![crates.io version][version-badge]][crate]
[![docs.rs][docs-badge]][docs]

[ci]: https://github.com/trillium-rs/trillium/actions?query=workflow%3ACI
[ci-badge]: https://github.com/trillium-rs/trillium/workflows/CI/badge.svg
[version-badge]: https://img.shields.io/crates/v/trillium-static-compiled.svg?style=flat-square
[crate]: https://crates.io/crates/trillium-static-compiled
[docs-badge]: https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square
[docs]: https://docs.rs/trillium-static-compiled

Serves static files embedded directly into the binary at compile time. No runtime feature flag
required. For serving files from the filesystem at runtime, see
[`trillium-static`](https://docs.rs/trillium-static).

## Example

```rust,no_run
use trillium_static_compiled::static_compiled;

let handler = static_compiled!("./public").with_index_file("index.html");
// run with your chosen runtime adapter, e.g.:
// trillium_tokio::run(handler);
```

The `static_compiled!` macro embeds the directory contents at compile time, so the binary is
self-contained — no filesystem access at runtime.

## ETag headers (default-on)

Each file is hashed at compile time and served with an `ETag` response header. The baked tag is
byte-identical to what
[`trillium_caching_headers::Etag`](https://docs.rs/trillium-caching-headers/latest/trillium_caching_headers/struct.Etag.html)
would compute at runtime, so adding `Etag::new()` after this handler in the chain gives you
`If-None-Match` / `304 Not Modified` for free without re-hashing the body.

Opt out per invocation: `static_compiled!("./public", etag = false)`.

## Precompression (opt-in via cargo features)

Pre-compress bundle contents into Brotli, Zstd, and Gzip variants at build time. Enable one or more
encoders via cargo features:

```toml
[dependencies]
trillium-static-compiled = { version = "*", features = ["compression"] }
# or pick individual encoders:
# features = ["brotli", "gzip"]
```

Then opt in per invocation:

```rust,ignore
static_compiled!("./public", compress);                  // every enabled encoder
static_compiled!("./public", compress = [Brotli, Gzip]); // a specific subset
```

The macro runs each encoder at maximum quality, in parallel via rayon. Per-file variants are sorted
smallest-first and only baked when they save at least 5%; files under 256 bytes are skipped
entirely. At request time the handler picks the smallest variant the client's `Accept-Encoding`
allows, sets `Content-Encoding`, and emits `Vary: Accept-Encoding`.

This composes with [`trillium-compression`](https://docs.rs/trillium-compression/), which passes
through any response that already has `Content-Encoding` set.

## Safety

This crate uses `#![forbid(unsafe_code)]`.

## License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

---

<sub>
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
</sub>