2 releases

0.1.1 Jan 25, 2024
0.1.0 Jan 5, 2024

#1310 in Development tools

Download history 397/week @ 2024-10-16 478/week @ 2024-10-23 409/week @ 2024-10-30 413/week @ 2024-11-06 270/week @ 2024-11-13 268/week @ 2024-11-20 679/week @ 2024-11-27 637/week @ 2024-12-04 513/week @ 2024-12-11 593/week @ 2024-12-18 682/week @ 2024-12-25 399/week @ 2025-01-01 847/week @ 2025-01-08 265/week @ 2025-01-15 495/week @ 2025-01-22 191/week @ 2025-01-29

1,822 downloads per month
Used in saasbase

MIT license

33KB
630 lines

Tower Serve Static

crates.io docs.rs Build Status dependency status codecov Lines Of Code

Tower file services using include_dir and include_bytes to embed assets into the binary.

Usage

Cargo.toml

tower-serve-static = { git = "https://github.com/jannik4/tower-serve-static", version = "0.1.0" }
include_dir = "0.7.0"

Serve Static File

use tower_serve_static::{ServeFile, include_file};

// File is located relative to `CARGO_MANIFEST_DIR` (the directory containing the manifest of your package).
// This will embed and serve the `README.md` file.
let service = ServeFile::new(include_file!("/README.md"));

// Run our service using `axum`
let app = axum::Router::new().nest_service("/", service);

// run our app with axum, listening locally on port 3000
let listener = tokio::net::TcpListener::bind("127.0.0.1:3000").await?;
axum::serve(listener, app).await?;

Serve Static Directory

use tower_serve_static::{ServeDir};
use include_dir::{Dir, include_dir};

// Use `$CARGO_MANIFEST_DIR` to make path relative to your package.
// This will embed and serve files in the `src` directory and its subdirectories.
static ASSETS_DIR: Dir<'static> = include_dir!("$CARGO_MANIFEST_DIR/src");
let service = ServeDir::new(&ASSETS_DIR);

// Run our service using `axum`
let app = axum::Router::new().nest_service("/", service);

// run our app with axum, listening locally on port 3000
let listener = tokio::net::TcpListener::bind("127.0.0.1:3000").await?;
axum::serve(listener, app).await?;

Credits

The implementation is based on the tower-http file services (more specifically version 0.1.2) and adapted to use include_dir/include_bytes instead of the filesystem at runtime.

Dependencies

~4–10MB
~98K SLoC