Struct EmbedFilesystem 

pub struct EmbedFilesystem { /* private fields */ }

A filesystem implementation that reads from embedded files.

This filesystem provides read-only access to files that have been embedded into the binary at compile time using rust-embed.

Implementations

impl EmbedFilesystem

pub fn new(provider: Box<dyn EmbedFilesystemProvider>) -> Self

Creates a new embedded filesystem with the given provider.

Arguments

• provider - The embedded file provider to use for file access

Returns

A new EmbedFilesystem instance.

pub fn with_root_dir(self, root_dir: &str) -> Self

Sets the root directory for this filesystem.

When a root directory is set, all file path lookups will be prefixed with this directory path. Trailing slashes and backslashes are automatically normalized to ensure consistent path formatting.

Arguments

• root_dir - The root directory path to use as a prefix

Returns

Self with the root directory configured

Examples

struct MockProvider;
impl EmbedFilesystemProvider for MockProvider {
    fn get(&self, _path: &str) -> Option<rust_embed::EmbeddedFile> { None }
}
let fs = EmbedFilesystem::new(Box::new(MockProvider))
    .with_root_dir("assets/");

Trait Implementations

impl Filesystem for EmbedFilesystem

fn read_bytes<'life0, 'life1, 'async_trait>( &'life0 self, asset_path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, FilesystemError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Reads the contents of an embedded file as bytes.

Arguments

• asset_path - The path to the asset file to read

Returns

The file contents as a Vec<u8> on success, or a FilesystemError if the file is not found.

Errors

Returns FilesystemError::NotFound if the requested file path does not exist in the embedded files.

fn write_bytes<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, asset_path: &'life1 str, data: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<(), FilesystemError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Asynchronously writes raw bytes to an asset file.