Struct gvfs::vfs::OverlayFS

pub struct OverlayFS { /* fields omitted */ }

A structure that joins several VFS's together in order.

So if a file isn't found in one FS it will search through them looking for it and return the

Methods

impl OverlayFS

pub fn new() -> Self

New OverlayFS containing zero filesystems.

pub fn push(&mut self, fs: Box<dyn VFS>)

Adds a new VFS to the end of the list.

pub fn roots(&self) -> &[Box<dyn VFS>]

Get a reference to the inner file systems, in search order.

Trait Implementations

impl VFS for OverlayFS

fn open_options(
    &self,
    path: &Path,
    open_options: OpenOptions
) -> Result<Box<dyn VFile>>

Open the file at this path with the given options

fn mkdir(&self, path: &Path) -> Result

Create a directory at the location by this path

fn rm(&self, path: &Path) -> Result

Remove a file

fn rmrf(&self, path: &Path) -> Result

Remove a file or directory and all its contents

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

Check if the file exists

fn metadata(&self, path: &Path) -> Result<Box<dyn VMetadata>>

Get the file's metadata

fn read_dir(
    &self,
    path: &Path
) -> Result<Box<dyn Iterator<Item = Result<PathBuf>>>>

Retrieve the path entries in this path

fn to_path_buf(&self) -> Option<PathBuf>

Retrieve the actual location of the VFS root, if available.

fn open(&self, path: &Path) -> Result<Box<dyn VFile>>

Open the file at this path for reading

fn create(&self, path: &Path) -> Result<Box<dyn VFile>>

Open the file at this path for writing, truncating it if it exists already

fn append(&self, path: &Path) -> Result<Box<dyn VFile>>

Open the file at this path for appending, creating it if necessary

impl Debug for OverlayFS

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.