Struct vfs::impls::overlay::OverlayFS

pub struct OverlayFS { /* private fields */ }

An overlay file system combining several filesystems into one, an upper layer with read/write access and lower layers with only read access

Files in upper layers shadow those in lower layers. Directories are the merged view of all layers.

NOTE: To allow removing files and directories (e.g. via remove_file()) from the lower layer filesystems, this mechanism creates a .whiteout folder in the root of the upper level filesystem to mark removed files

Implementations

impl OverlayFS

pub fn new(layers: &[VfsPath]) -> Self

Create a new overlay FileSystem from the given layers, only the first layer is written to

Trait Implementations

impl Clone for OverlayFS

fn clone(&self) -> OverlayFS

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OverlayFS

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

Formats the value using the given formatter.

impl FileSystem for OverlayFS

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

Iterates over all entries of this directory path

fn create_dir(&self, path: &str) -> VfsResult<()>

Creates the directory at this path

fn open_file(&self, path: &str) -> VfsResult<Box<dyn SeekAndRead>>

Opens the file at this path for reading

fn create_file(&self, path: &str) -> VfsResult<Box<dyn Write>>

Creates a file at this path for writing

fn append_file(&self, path: &str) -> VfsResult<Box<dyn Write>>

Opens the file at this path for appending

fn metadata(&self, path: &str) -> VfsResult<VfsMetadata>

Returns the file metadata for the file at this path

fn exists(&self, path: &str) -> VfsResult<bool>

Returns true if a file or directory at path exists, false otherwise

fn remove_file(&self, path: &str) -> VfsResult<()>

Removes the file at this path

fn remove_dir(&self, path: &str) -> VfsResult<()>

Removes the directory at this path

fn copy_file(&self, _src: &str, _dest: &str) -> VfsResult<()>

Copies the src path to the destination path within the same filesystem (optional)

fn move_file(&self, _src: &str, _dest: &str) -> VfsResult<()>

Moves the src path to the destination path within the same filesystem (optional)

fn move_dir(&self, _src: &str, _dest: &str) -> VfsResult<()>

Moves the src directory to the destination path within the same filesystem (optional)