Struct FsResourceIo

pub struct FsResourceIo;

Standard resource IO provider that uses the file system to load the file bytes

Trait Implementations

impl Default for FsResourceIo

fn default() -> FsResourceIo

Returns the “default value” for a type.

impl ResourceIo for FsResourceIo

fn read_directory<'a>( &'a self, path: &'a Path, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn Iterator<Item = PathBuf> + Send>, FileLoadError>> + Send + 'a>>

wasm should fallback to the default no-op impl as im not sure if they can directly read a directory

Note: Android directory reading should be possible just I have not created an implementation for this yet

fn walk_directory<'a>( &'a self, path: &'a Path, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn Iterator<Item = PathBuf> + Send>, FileLoadError>> + Send + 'a>>

Android and wasm should fallback to the default no-op impl as they cant be walked with WalkDir

fn file_reader<'a>( &'a self, path: &'a Path, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn FileReader>, FileLoadError>> + Send + 'a>>

Only use file reader when not targetting android or wasm

Note: Might be possible to use the Android Asset struct for reading as long as its Send + Sync + ’static (It already implements Debug + Read + Seek)

fn load_file<'a>( &'a self, path: &'a Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, FileLoadError>> + Send + 'a>>

Attempts to load the file at the provided path returning the entire byte contents of the file or an error

fn move_file<'a>( &'a self, source: &'a Path, dest: &'a Path, ) -> Pin<Box<dyn Future<Output = Result<(), FileLoadError>> + Send + 'a>>

Attempts to move a file at the given source path to the given dest path.

fn canonicalize_path<'a>( &'a self, path: &'a Path, ) -> Pin<Box<dyn Future<Output = Result<PathBuf, FileLoadError>> + Send + 'a>>

Tries to convert the path to its canonical form (normalize it in other terms). This method should guarantee correct behaviour for relative paths. Symlinks aren’t mandatory to follow.

fn exists<'a>( &'a self, path: &'a Path, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'a>>

Used to check whether a path exists

fn is_file<'a>( &'a self, path: &'a Path, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'a>>

Used to check whether a path is a file

fn is_dir<'a>( &'a self, path: &'a Path, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'a>>

Used to check whether a path is a dir