Struct bevy_asset::FileAssetIo

pub struct FileAssetIo { /* private fields */ }

I/O implementation for the local filesystem.

This asset I/O is fully featured but it’s not available on android and wasm targets.

Implementations

impl FileAssetIo

pub fn new<P: AsRef<Path>>(path: P, watch_for_changes: bool) -> Self

Creates a new FileAssetIo at a path relative to the executable’s directory, optionally watching for changes.

See get_base_path below.

pub fn get_base_path() -> PathBuf

Returns the base path of the assets directory, which is normally the executable’s parent directory.

If a BEVY_ASSET_ROOT environment variable is set, then its value will be used.

Else if the CARGO_MANIFEST_DIR environment variable is set, then its value will be used instead. It’s set by cargo when running with cargo run.

pub fn root_path(&self) -> &PathBuf

Returns the root directory where assets are loaded from.

See get_base_path.

Trait Implementations

impl AssetIo for FileAssetIo

fn load_path<'a>( &'a self, path: &'a Path ) -> BoxedFuture<'a, Result<Vec<u8>, AssetIoError>>

Returns a future to load the full file data at the provided path.

fn read_directory( &self, path: &Path ) -> Result<Box<dyn Iterator<Item = PathBuf>>, AssetIoError>

Returns an iterator of directory entry names at the provided path.

fn watch_path_for_changes( &self, to_watch: &Path, to_reload: Option<PathBuf> ) -> Result<(), AssetIoError>

Tells the asset I/O to watch for changes recursively at the provided path.

fn watch_for_changes(&self) -> Result<(), AssetIoError>

Enables change tracking in this asset I/O.

fn get_metadata(&self, path: &Path) -> Result<Metadata, AssetIoError>

Returns metadata about the filesystem entry at the provided path.

fn is_dir(&self, path: &Path) -> bool

Returns true if the path is a directory.

fn is_file(&self, path: &Path) -> bool

Returns true if the path is a file.