Struct VirtualFileSystem

pub struct VirtualFileSystem { /* private fields */ }

A reference to an virtual file system.

Implementations

impl VirtualFileSystem

pub fn try_new<P>(root: P) -> Result<VirtualFileSystem, Error>

where P: AsRef<Path>,

Creates new VirtualFileSystem.

root - base directory for VFS. A root path must exists; else return value will be io::Error. It will be normalized.

pub fn root(&self) -> PathBuf

Returns a root path.

pub fn absolute<P>(&self, path: P) -> Option<PathBuf>

where P: AsRef<Path>,

Convert relative path to absolute.

If path is absolute and starts with current root, then return it, else return None. If path is relative, then append it to the end of the current root and return joined path.

pub fn relative<P>(&self, path: P) -> Option<PathBuf>

where P: AsRef<Path>,

Convert absolute path to relative.

If path is relative, then normalize it and return. If path is equal to root, then return . (current). If root equals to /foo/bar and path equals to /foo/bar/more, then return more.

pub fn exists<P>(&self, path: P) -> bool

where P: AsRef<Path>,

Returns true if the path points at an existing entity.

pub fn chroot<P>(&mut self, new_root: P) -> bool

where P: AsRef<Path>,

Change current root.

A new_root path may be absolute or relative. Return true if root was change.

pub fn create_dir<P>(&self, path: P) -> Result<(), Error>

where P: AsRef<Path>,

Creates a new, empty directory at the provided path.

pub fn create_dir_all<P>(&self, path: P) -> Result<(), Error>

where P: AsRef<Path>,

Recursively create a directory and all of its parent components if they are missing.

pub fn remove_dir<P>(&self, path: P) -> Result<(), Error>

where P: AsRef<Path>,

Removes an existing, empty directory.

pub fn remove_dir_all<P>(&self, path: P) -> Result<(), Error>

where P: AsRef<Path>,

Removes a directory at this path, after removing all its contents. Use carefully!

pub fn visit_all(&self, cb: &dyn Fn(&DirEntry)) -> Result<(), Error>

Recursively traverses the contents of the directory and calls a callback for each item.