Struct RocFS

pub struct RocFS {
    pub layers: Vec<Box<dyn FileSystem>>,
}

“Read-only collection” filesystem. Does not support writing, but supports reading from any of the layers. Differs from OverlayFS in that it only supports reading and is much less complex and doesn’t need to write a .whiteout directory that can sometimes prove problematic.

Fields

layers: Vec<Box<dyn FileSystem>>

Implementations

impl RocFS

pub fn new(layers: Vec<Box<dyn FileSystem>>) -> Self

Creates a new read-only collection filesystem from layers. Layers will be traversed in order of their appearance in the vector.

Argument

layers: The layers of the filesystem.

Trait Implementations

impl FileSystem for RocFS

fn create_dir(&self, _path: &str) -> Result<()>

Creates a directory at path.

fn metadata(&self, path: &str) -> Result<Metadata>

Returns the metadata for the file/folder at `path.

fn open_file_options( &self, path: &str, options: &OpenOptions, ) -> Result<Box<dyn File>>

Opens a file at path with options options.

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

Lists the files and folders contained in the directory denoted by path.

fn remove_dir(&self, _path: &str) -> Result<()>

Removes the directory at path.

fn remove_file(&self, _path: &str) -> Result<()>

Removes a file at path.

fn create_dir_all(&self, path: &str) -> Result<()>

Creates a directory path and all of its parents.

fn create_file(&self, path: &str) -> Result<Box<dyn File>>

Creates a file at path in write mode. The file will be opened in truncate mode, so all contents will be overwritten. If this is not desirable, use open_file directly.

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

Returns Ok(true) or Ok(false) if a file or folder at path does or does not exist, and Err(_) if the presence cannot be verified.

fn open_file(&self, path: &str) -> Result<Box<dyn File>>

Opens a file at path for reading.