Type Alias IncludeFs

pub type IncludeFs = LazyLock<IncludeFsInner>;

A lazy-loaded file system embedded in the binary.

The index will be parsed the first time it is accessed. Since only filenames are read on initialization, this should be very fast. To make sure the index is not read in a time-critical path, the lock can be manually initialized beforehand:

static ASSETS: IncludeFs = include_fs!("assets");

// This will block until the index fs is loaded.
let _ = &*ASSETS;

Aliased Type

pub struct IncludeFs { /* private fields */ }