Struct StaticFileHandler 

pub struct StaticFileHandler { /* private fields */ }

trillium handler to serve static files from the filesystem

Implementations

impl StaticFileHandler

pub fn new(fs_root: impl AsRef<Path>) -> Self

builds a new StaticFileHandler

If the fs_root is a file instead of a directory, that file will be served at all paths.

use trillium_static::{StaticFileHandler, crate_relative_path};
use trillium_testing::TestServer;

let mut handler = StaticFileHandler::new(crate_relative_path!("examples/files"));
let app = TestServer::new(handler).await;

app.get("/").await.assert_status(Status::NotFound); // no index file configured

app.get("/index.html")
    .await
    .assert_ok()
    .assert_body("<h1>hello world</h1>\n")
    .assert_header("content-type", "text/html; charset=utf-8");

pub fn with_precompressed(self) -> Self

Enable serving precompressed sidecar files for the standard set of content codings: brotli (.br), zstd (.zst), and gzip (.gz), in that match-priority order.

For each request whose Accept-Encoding allows one of these codings, the handler looks for a sibling file at <asset>.<suffix> and, if present, serves it with Content-Encoding set to the coding token. The original asset’s MIME type is preserved.

When precompression is enabled, every response from this handler sets Vary: Accept-Encoding — including the uncompressed-original fallback — so caches do not serve a compressed response to a client that did not ask for one (or vice versa).

Equivalent to chaining three calls:

handler
    .with_precompressed_variant("br", "br")
    .with_precompressed_variant("zstd", "zst")
    .with_precompressed_variant("gzip", "gz")

To register additional codings or use only a subset, use with_precompressed_variant directly.

This composes with trillium-compression: when this handler sets Content-Encoding, the compression middleware skips the body and passes it through unchanged.

pub fn with_precompressed_variant( self, encoding: impl Into<String>, suffix: impl Into<String>, ) -> Self

Register a precompressed-sidecar variant. Calls are additive and preserve registration order — earlier registrations win when a client accepts more than one.

encoding is the HTTP content-coding token used in the Content-Encoding response header (e.g. "br", "gzip", "zstd"). suffix is the on-disk filename suffix without the leading dot (e.g. "br", "gz", "zst").

Most callers want with_precompressed, which registers the standard set with conventional suffixes. Use this method to register a custom coding (for example, a non-standard suffix from a build pipeline) or to opt into only a subset of the defaults.

pub fn without_etag_header(self) -> Self

do not set an etag header

pub fn without_modified_header(self) -> Self

do not set last-modified header

pub fn with_index_file(self, file: &str) -> Self

sets the index file on this StaticFileHandler

use trillium_static::{StaticFileHandler, crate_relative_path};

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

app.get("/")
    .await
    .assert_ok()
    .assert_body("<h1>hello world</h1>\n")
    .assert_header("content-type", "text/html; charset=utf-8");

Trait Implementations

impl Debug for StaticFileHandler

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Handler for StaticFileHandler

async fn init(&mut self, _info: &mut Info)

Performs one-time async set up on a mutable borrow of the Handler before the server starts accepting requests. This allows a Handler to be defined in synchronous code but perform async setup such as establishing a database connection or fetching some state from an external source. This is optional, and chances are high that you do not need this.

async fn run(&self, conn: Conn) -> Conn

Executes this handler, performing any modifications to the Conn that are desired.

fn before_send(&self, conn: Conn) -> impl Future<Output = Conn> + Send

Performs any final modifications to this conn after all handlers have been run. Although this is a slight deviation from the simple conn->conn->conn chain represented by most Handlers, it provides an easy way for libraries to effectively inject a second handler into a response chain. This is useful for loggers that need to record information both before and after other handlers have run, as well as database transaction handlers and similar library code.

fn has_upgrade(&self, upgrade: &Upgrade) -> bool

predicate function answering the question of whether this Handler would like to take ownership of the negotiated Upgrade. If this returns true, you must implement Handler::upgrade. The first handler that responds true to this will receive ownership of the trillium::Upgrade in a subsequent call to Handler::upgrade

fn upgrade(&self, upgrade: Upgrade) -> impl Future<Output = ()> + Send

This will only be called if the handler reponds true to Handler::has_upgrade and will only be called once for this upgrade. There is no return value, and this function takes exclusive ownership of the underlying transport once this is called. You can downcast the transport to whatever the source transport type is and perform any non-http protocol communication that has been negotiated. You probably don’t want this unless you’re implementing something like websockets. Please note that for many transports such as TcpStreams, dropping the transport (and therefore the Upgrade) will hang up / disconnect.

fn name(&self) -> Cow<'static, str>

Customize the name of your handler. This is used in Debug implementations. The default is the type name of this handler.