Struct FileAssetReader

pub struct FileAssetReader { /* private fields */ }

Available on non-WebAssembly only.

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 FileAssetReader

pub fn new<P: AsRef<Path>>(path: P) -> 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 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 AssetReader for FileAssetReader

Available on non-crate feature multi_threaded only.

async fn read<'a>( &'a self, path: &'a Path, ) -> Result<Box<Reader<'a>>, AssetReaderError>

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

async fn read_meta<'a>( &'a self, path: &'a Path, ) -> Result<Box<Reader<'a>>, AssetReaderError>

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

async fn read_directory<'a>( &'a self, path: &'a Path, ) -> Result<Box<PathStream>, AssetReaderError>

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

async fn is_directory<'a>( &'a self, path: &'a Path, ) -> Result<bool, AssetReaderError>

Returns true if the provided path points to a directory.

fn read_meta_bytes<'a>( &'a self, path: &'a Path, ) -> impl ConditionalSendFuture<Output = Result<Vec<u8>, AssetReaderError>>

Reads asset metadata bytes at the given path into a Vec<u8>. This is a convenience function that wraps AssetReader::read_meta by default.