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
//! This crate provides a [`tower`] service designed to provide embedded static
//! assets support for web application. This service includes the following HTTP features:
//!
//! - Support for GET and HEAD requests
//! - `Content-Type` header generation based on file MIME type guessed from extension.
//! - `ETag` header generation and validation.
//! - `Last-Modified` header generation and validation.
//! - Customizable 404 page.
//!
//! In `debug` mode, assets are served directly from the filesystem to facilitate rapid
//! development. Both `ETag` and `Last-Modified` headers are not generated in this mode.
//!
//! The optional feature `astro` can be used to enable support for embedding [Astro] project. In
//! release mode the project is build and embedded as static assets, while in debug mode the
//! service acts as a proxy server pointing to the development server.
//!
//! ## Features
//!
//! * **astro** - Enable support for [Astro] projects.
//!
//! ## Usage
//!
//! ```no_run
//! use axum::Router;
//! use tower_embed::{EmbedExt, EmbedFolder, ServeEmbed};
//!
//! #[derive(Embed)]
//! #[embed(folder = "assets")]
//! struct Assets;
//!
//! #[tokio::main]
//! async fn main() {
//! let assets = ServeEmbed::<Assets>::new().with_not_found(Assets::not_found_page("404.html"));
//! let router = Router::new().fallback_service(assets);
//!
//! let listener = tokio::net::TcpListener::bind("127.0.0.1:8080")
//! .await
//! .unwrap();
//! axum::serve::serve(listener, router).await.unwrap();
//! }
//! ```
//!
//! Please see the [examples] directory for working examples.
//!
//! [`tower`]: https://crates.io/crates/tower
//! [examples]: https://github.com/mattiapenati/tower-embed/tree/main/examples
//! [Astro]: https://astro.build/
compile_error!;
pub use Embed;
pub use tower_embed_core as core;
pub use ;