tower-serve-static

Crates.iotower-serve-static
lib.rstower-serve-static
version0.1.1
sourcesrc
created_at2024-01-05 19:58:24.711677
updated_at2024-01-25 21:04:46.783425
descriptionTower service that serves static files.
homepagehttps://github.com/jannik4/tower-serve-static
repositoryhttps://github.com/jannik4/tower-serve-static
max_upload_size
id1090255
size44,536
Jannik Obermann (jannik4)

documentation

README

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.

Commit count: 0

cargo fmt