Trait FileSystem

Source

pub trait FileSystem:
    Debug
    + Sync
    + Send
    + 'static {
Show 16 methods    // Required methods
    fn read_dir(
        &self,
        path: &str,
    ) -> VfsResult<Box<dyn Iterator<Item = String> + Send>>;
    fn create_dir(&self, path: &str) -> VfsResult<()>;
    fn open_file(&self, path: &str) -> VfsResult<Box<dyn SeekAndRead + Send>>;
    fn create_file(&self, path: &str) -> VfsResult<Box<dyn SeekAndWrite + Send>>;
    fn append_file(&self, path: &str) -> VfsResult<Box<dyn SeekAndWrite + Send>>;
    fn metadata(&self, path: &str) -> VfsResult<VfsMetadata>;
    fn exists(&self, path: &str) -> VfsResult<bool>;
    fn remove_file(&self, path: &str) -> VfsResult<()>;
    fn remove_dir(&self, path: &str) -> VfsResult<()>;

    // Provided methods
    fn set_creation_time(&self, _path: &str, _time: SystemTime) -> VfsResult<()> { ... }
    fn set_modification_time(
        &self,
        _path: &str,
        _time: SystemTime,
    ) -> VfsResult<()> { ... }
    fn set_access_time(&self, _path: &str, _time: SystemTime) -> VfsResult<()> { ... }
    fn copy_file(&self, _src: &str, _dest: &str) -> VfsResult<()> { ... }
    fn move_file(&self, _src: &str, _dest: &str) -> VfsResult<()> { ... }
    fn move_dir(&self, _src: &str, _dest: &str) -> VfsResult<()> { ... }
    fn real_path(&self, _path: &str) -> VfsResult<PathBuf> { ... }
}

Expand description

File system implementations must implement this trait All path parameters are absolute, starting with ‘/’, except for the root directory which is simply the empty string (i.e. “”) The character ‘/’ is used to delimit directories on all platforms. Path components may be any UTF-8 string, except “/”, “.” and “..”

Please use the test_macros [test_macros::test_vfs!] and [test_macros::test_vfs_readonly!]

Required Methods§

Source

fn read_dir( &self, path: &str, ) -> VfsResult<Box<dyn Iterator<Item = String> + Send>>

Iterates over all direct children of this directory path NOTE: the returned String items denote the local bare filenames, i.e. they should not contain “/” anywhere

Source