Static Files

​

Description

This example has one route at / where the homepage is served and shows you how you can serve HTML or other types of files with Rocket.

Note that static assets are declared in the Shuttle.toml file.

You can clone the example below by running the following (you’ll need shuttle CLI installed):

shuttle init --from shuttle-hq/shuttle-examples --subfolder rocket/static-files

​

Code

use rocket::fs::NamedFile;
use rocket::fs::{relative};
use std::path::{Path, PathBuf};

#[rocket::get("/<path..>")]
pub async fn serve(mut path: PathBuf) -> Option<NamedFile> {
    path.set_extension("html");
    let mut path = Path::new(relative!("assets")).join(path);
    if path.is_dir() {
        path.push("index.html");
    }

    NamedFile::open(path).await.ok()
}

#[shuttle_runtime::main]
async fn rocket() -> shuttle_rocket::ShuttleRocket {
    let rocket = rocket::build().mount("/", rocket::routes![serve]);

    Ok(rocket.into())
}

​

Usage

After you clone the example, launch it locally by using shuttle run then visit the home route at http://localhost:8000 - you should see a homepage that shows our included HTML file.

You can extend this example by adding more routes that serve other files.