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>, FileError>> + 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, max_depth: usize, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn Iterator<Item = PathBuf> + Send>, FileError>> + 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>, FileError>> + 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 can_write(&self) -> bool

True if writing to files is possible through this object.

fn can_read_directories(&self) -> bool

True if reading the content of directories is possible through this object.

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

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

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

Attempts to asynchronously write the given set of bytes to the specified path.

fn write_file_sync(&self, path: &Path, data: &[u8]) -> Result<(), FileError>

Attempts to synchronously write the given set of bytes to the specified path. This method is optional, on some platforms it may not even be supported (WebAssembly).

fn create_dir_all_sync(&self, path: &Path) -> Result<(), FileError>

Creates a directory with all subdirectories defined by the specified path.

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

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

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

Attempts to delete a file at the given path asynchronously.

fn delete_file_sync(&self, path: &Path) -> Result<(), FileError>

Attempts to delete a file at the given path synchronously.

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

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

fn canonicalize_path<'a>(&'a self, path: &'a Path) -> Result<PathBuf, FileError>

Tries to convert the path to its canonical form (normalize it in other terms), and put the path into a form that is suited for use in methods of this object. Each file should have exactly one canonical path. This method should guarantee correct behaviour for relative paths. Symlinks aren’t mandatory to follow.

fn is_valid_file_name(&self, name: &OsStr) -> bool

Checks whether the given file name is valid or not.

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

Used to check whether a path exists

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

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