Struct virtual_fs::mem_fs::FileSystem

pub struct FileSystem {
    pub(super) inner: Arc<RwLock<FileSystemInner>>,
}

The in-memory file system!

This FileSystem type can be cloned, it’s a light copy of the FileSystemInner (which is behind a Arc + RwLock).

Fields

inner: Arc<RwLock<FileSystemInner>>

Implementations

impl FileSystem

pub fn insert_ro_file( &self, path: &Path, contents: Cow<'static, [u8]>, ) -> Result<()>

Inserts a readonly file into the file system that uses copy-on-write (this is required for zero-copy creation of the same file)

pub fn insert_arc_file_at( &self, target_path: PathBuf, fs: Arc<dyn FileSystem + Send + Sync>, source_path: PathBuf, ) -> Result<()>

Inserts a arc file into the file system that references another file in another file system (does not copy the real data)

pub fn insert_arc_file( &self, target_path: PathBuf, fs: Arc<dyn FileSystem + Send + Sync>, ) -> Result<()>

Inserts a arc file into the file system that references another file in another file system (does not copy the real data)

pub fn insert_arc_directory_at( &self, target_path: PathBuf, other: Arc<dyn FileSystem + Send + Sync>, source_path: PathBuf, ) -> Result<()>

Inserts a arc directory into the file system that references another file in another file system (does not copy the real data)

pub fn insert_arc_directory( &self, target_path: PathBuf, other: Arc<dyn FileSystem + Send + Sync>, ) -> Result<()>

Inserts a arc directory into the file system that references another file in another file system (does not copy the real data)

pub fn insert_device_file( &self, path: PathBuf, file: Box<dyn VirtualFile + Send + Sync>, ) -> Result<()>

Inserts a arc file into the file system that references another file in another file system (does not copy the real data)

fn insert_inode( &self, path: &Path, ) -> Result<(InodeResolution, Option<InodeResolution>, OsString)>

impl FileSystem

pub fn set_memory_limiter(&self, limiter: DynFsMemoryLimiter)

pub fn new_open_options_ext(&self) -> &FileSystem

pub fn with_backing_offload(self, buffer: OffloadBackingStore) -> Result<Self>

Uses a mmap’ed file as a cache for file data thus removing the need to copy the data into memory.

This is especially important for journals as it means that the data stored within the journals does not need to be copied into memory, for very large journals this would otherwise be a problem.

pub fn canonicalize_unchecked(&self, path: &Path) -> Result<PathBuf>

Canonicalize a path without validating that it actually exists.

pub fn mount_directory_entries( &self, target_path: &Path, other: &Arc<dyn FileSystem + Send + Sync>, source_path: &Path, ) -> Result<()>

Merge all items from a given source path (directory) of a different file system into this file system.

Individual files and directories of the given path are mounted.

This function is not recursive, only the items in the source_path are mounted.

See Self::union for mounting all inodes recursively.

pub fn union(&self, other: &Arc<dyn FileSystem + Send + Sync>)

pub fn mount( &self, target_path: PathBuf, other: &Arc<dyn FileSystem + Send + Sync>, source_path: PathBuf, ) -> Result<()>

Trait Implementations

impl Clone for FileSystem

fn clone(&self) -> FileSystem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileSystem

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

Formats the value using the given formatter.

impl Default for FileSystem

fn default() -> FileSystem

Returns the “default value” for a type.

impl FileOpener for FileSystem

fn open( &self, path: &Path, conf: &OpenOptionsConfig, ) -> Result<Box<dyn VirtualFile + Send + Sync + 'static>>

impl FileSystem for FileSystem

fn readlink(&self, path: &Path) -> Result<PathBuf>

fn read_dir(&self, path: &Path) -> Result<ReadDir>

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

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

fn rename<'a>( &'a self, from: &'a Path, to: &'a Path, ) -> BoxFuture<'a, Result<()>>

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

fn symlink_metadata(&self, path: &Path) -> Result<Metadata>

This method gets metadata without following symlinks in the path. Currently identical to metadata because symlinks aren’t implemented yet.

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

fn new_open_options(&self) -> OpenOptions<'_>

fn mount( &self, _name: String, path: &Path, fs: Box<dyn FileSystem + Send + Sync>, ) -> Result<()>