Struct FileSystem 

pub struct FileSystem {
    path: PathBuf,
}

A Source to load assets from a directory in the file system.

This is the default Source of [AssetCache].

Hot-reloading

This source supports hot-reloading: when a file is edited, the assets that use it are reloaded.

WebAssembly

This source does not work in WebAssembly, because there is no file system. When called, it always returns an error.

Fields

path: PathBuf

Implementations

impl FileSystem

pub fn new<P>(path: P) -> Result<FileSystem, Error>

where P: AsRef<Path>,

Creates a new FileSystem from a directory.

Generally you do not need to call this function directly, as the [AssetCache::new] method provides a shortcut to create a cache reading from the filesystem.

Errors

An error can occur if path is not a valid readable directory.

pub fn root(&self) -> &Path

Gets the path of the source’s root.

The path is currently given as absolute, but this may change in the future.

pub fn path_of(&self, entry: DirEntry<'_>) -> PathBuf

Returns the path that the directory entry would have if it exists.

Trait Implementations

impl Clone for FileSystem

fn clone(&self) -> FileSystem

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileSystem

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

Formats the value using the given formatter.

impl Source for FileSystem

fn read(&self, id: &str, ext: &str) -> Result<FileContent<'_>, Error>

Try reading the source given an id and an extension.

fn read_dir( &self, id: &str, f: &mut dyn FnMut(DirEntry<'_>), ) -> Result<(), Error>

Reads the content of a directory.

fn exists(&self, entry: DirEntry<'_>) -> bool

Returns true if the entry points at an existing entity.

fn configure_hot_reloading( &self, events: EventSender, ) -> Result<(), Box<dyn Error + Sync + Send>>

Starts hot-reloading.