Crate trillium_static

Serves static file assets from the file system.

use trillium_static::{StaticFileHandler, crate_relative_path};


let mut handler = StaticFileHandler::new(crate_relative_path!("examples/files"))
    .with_index_file("index.html");


// given the following directory layout
//
// examples/files
// ├── index.html
// ├── subdir
// │  └── index.html
// └── subdir_with_no_index
//    └── plaintext.txt
//


use trillium_testing::prelude::*;

handler.init(&mut "testing".into()).await;

assert_ok!(
    get("/").run_async(&handler).await,
    "<h1>hello world</h1>",
    "content-type" => "text/html; charset=utf-8"
);
assert_not_handled!(get("/file_that_does_not_exist.txt").run_async(&handler).await);
assert_ok!(get("/index.html").run_async(&handler).await);
assert_ok!(get("/subdir/index.html").run_async(&handler).await, "subdir index.html");
assert_ok!(get("/subdir").run_async(&handler).await, "subdir index.html");
assert_not_handled!(get("/subdir_with_no_index").run_async(&handler).await);
assert_ok!(
    get("/subdir_with_no_index/plaintext.txt").run_async(&handler).await,
    "plaintext file",
    "content-type" => "text/plain; charset=utf-8"
);


// with a different index file
let plaintext_index = StaticFileHandler::new(crate_relative_path!("examples/files"))
    .with_index_file("plaintext.txt");

assert_not_handled!(get("/").run_async(&plaintext_index).await);
assert_not_handled!(get("/subdir").run_async(&plaintext_index).await);
assert_ok!(
    get("/subdir_with_no_index").run_async(&plaintext_index).await,
    "plaintext file",
    "content-type" => "text/plain; charset=utf-8"
);

❗IMPORTANT❗

this crate has three features currently: smol, async-std, and tokio.

You must enable one of these in order to use the crate. This is intended to be a temporary situation, and eventually you will not need to specify the runtime through feature flags.

stability note

Please note that this crate is fairly incomplete, while functional. It does not include any notion of range requests or cache headers. It serves all files from disk every time, with no in-memory caching.

Re-exports

• pub use relative_path;

Macros

• crate_relative_path
  a convenient helper macro to build a str relative to the crate root

Structs

• StaticFileHandler
  trillium handler to serve static files from the filesystem

Traits

• StaticConnExt
  conn extension trait to facilitate sending individual files and paths

Functions

• files
  convenience alias for StaticFileHandler::new