Struct MemoryServe

pub struct MemoryServe { /* private fields */ }

Helper struct to create and configure an axum to serve static files from memory.

Implementations

impl MemoryServe

pub fn new(assets: &'static [Asset]) -> Self

Initiate a MemoryServe instance, takes the output of load_assets! as an argument. load_assets! takes a directory name relative from the project root.

pub fn from_env() -> Self

Initiate a MemoryServe instance, takes the contents of memory_serve_assets.bin created at build time. Specify which asset directory to include using the environment variable ASSET_DIR.

pub fn from_env_name(name: &str) -> Self

Include a directory using a named environment variable, prefixed by ASSRT_DIR_. Specify which asset directory to include using the environment variable ASSET_DIR_<SOME NAME>. The name should be in uppercase. For example to include assets from the public directory using the name PUBLIC, set the enirobment variable ASSET_DIR_PUBLIC=./public and call MemoryServe::from_name("PUBLIC").

pub fn index_file(self, index_file: Option<&'static str>) -> Self

Which static file to serve on the route “/” (the index) The path (or route) should be relative to the directory set with the ASSET_DIR variable, but prepended with a slash. By default this is Some("/index.html")

pub fn index_on_subdirectories(self, enable: bool) -> Self

Whether to serve the corresponding index.html file when a route matches a subdirectory

pub fn fallback(self, fallback: Option<&'static str>) -> Self

Which static file to serve when no other routes are matched, also see fallback The path (or route) should be relative to the directory set with the ASSET_DIR variable, but prepended with a slash. By default this is None, which means axum will return an empty response with a HTTP 404 status code when no route matches.

pub fn fallback_status(self, fallback_status: StatusCode) -> Self

What HTTP status code to return when a static file is returned by the fallback handler.

pub fn enable_gzip(self, enable_gzip: bool) -> Self

Whether to enable gzip compression. When set to true, clients that accept gzip compressed files, but not brotli compressed files, are served gzip compressed files.

pub fn enable_brotli(self, enable_brotli: bool) -> Self

Whether to enable brotli compression. When set to true, clients that accept brotli compressed files are served brotli compressed files.

pub fn enable_clean_url(self, enable_clean_url: bool) -> Self

Whether to enable clean URLs. When set to true, the routing path for HTML files will not include the extension so that a file located at “/about.html” maps to “/about” instead of “/about.html”.

pub fn html_cache_control(self, html_cache_control: CacheControl) -> Self

The Cache-Control header to set for HTML files. See Cache control for options.

pub fn cache_control(self, cache_control: CacheControl) -> Self

Cache header to non-HTML files. See Cache control for options.

pub fn add_alias(self, from: &'static str, to: &'static str) -> Self

Create an alias for a route / file

pub fn into_router<S>(self) -> Router<S>

where S: Clone + Send + Sync + 'static,

Create an axum Router instance that will serve the included static assets Caution! This method leaks memory. It should only be called once (at startup).

Trait Implementations

impl Debug for MemoryServe

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

Formats the value using the given formatter.

impl Default for MemoryServe

fn default() -> MemoryServe

Returns the “default value” for a type.