Struct PluginAssets 

pub struct PluginAssets { /* private fields */ }

A set of files compiled into a crate and served with content-hashed URLs.

Build one with plugin_assets! (a directory; embed-assets feature) or PluginAssets::from_files (an explicit list), store it in a static, and install it with AppBuilder::plugin_assets. See the module docs for the URL scheme and caching policy.

Hashes are computed once, the first time the bundle is used.

Implementations

impl PluginAssets

pub const fn from_files( namespace: &'static str, files: &'static [(&'static str, &'static [u8])], ) -> Self

A bundle from an explicit list of (logical path, bytes) pairs.

Use this when the files are already include_bytes!/include_str! constants, or when the crate does not enable embed-assets:

use autumn_web::assets::PluginAssets;

static ASSETS: PluginAssets = PluginAssets::from_files(
    "charts",
    &[("charts.js", b"console.log('charts');")],
);
assert!(ASSETS.url("charts.js").starts_with("/static/_plugins/charts/charts."));

A logical path is relative (no leading /), uses / separators, and has no .. or empty segments. Entries that break these rules, and dotfiles, are skipped with a warning when the bundle is first used.

Panics

Panics if namespace is empty, longer than 64 bytes, or contains anything other than ASCII lowercase letters, digits, - and _. In a static this is a compile-time error.

pub const fn from_dir( namespace: &'static str, dir: &'static Dir<'static>, ) -> Self

A bundle from a directory embedded with include_dir!. Every file in the tree is included, except dotfiles. Prefer the plugin_assets! macro, which embeds the directory for you.

Panics

Same namespace rules as from_files.

pub const fn namespace(&self) -> &'static str

The bundle’s namespace, e.g. "motion".

pub fn mount_path(&self) -> String

The URL path the bundle is served under, e.g. /static/_plugins/motion.

pub fn get(&self, logical_path: &str) -> Option<&PluginAsset>

The file at logical_path, or None when the bundle has no such file.

pub fn iter(&self) -> impl Iterator<Item = &PluginAsset>

Every file in the bundle, sorted by logical path.

pub fn url(&self, logical_path: &str) -> String

The content-hashed URL of logical_path.

When the bundle has no such file this logs a warning and returns the plain URL, which will 404. Use get to handle a missing file yourself.

pub fn integrity(&self, logical_path: &str) -> Option<&str>

The sha384-<base64> Subresource Integrity hash of logical_path.

pub fn script_tag(&self, logical_path: &str) -> Markup

A <script> tag for logical_path, with the hashed src, integrity and crossorigin="anonymous".

When the bundle has no such file this logs a warning and returns an HTML comment naming the file, so the gap shows in View Source.

pub fn deferred_script_tag(&self, logical_path: &str) -> Markup

Like script_tag, with the defer attribute.

pub fn stylesheet_tag(&self, logical_path: &str) -> Markup

A <link rel="stylesheet"> tag for logical_path, with the hashed href, integrity and crossorigin="anonymous".

A missing file behaves as in script_tag.

pub fn router<S>(&'static self) -> Router<S>

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

A router serving every file at both its plain and its fingerprinted URL, using absolute paths. Merge it yourself only for a custom setup; AppBuilder::plugin_assets mounts the bundle for you.

pub fn route_infos(&self) -> Vec<RouteInfo>

The bundle’s routes in the shape autumn routes lists them. Static files are public, so every entry is classified Public and does not trip autumn routes audit.

Trait Implementations

impl Debug for PluginAssets

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

Formats the value using the given formatter.