Struct memofs::VfsLock

pub struct VfsLock<'a> { /* fields omitted */ }

A locked handle to a Vfs, created by Vfs::lock.

Implements roughly the same API as Vfs.

Implementations

impl VfsLock<'_>

pub fn set_watch_enabled(&mut self, enabled: bool)

Turns automatic file watching on or off. Enabled by default.

Turning off file watching may be useful for single-use cases, especially on platforms like macOS where registering file watches has significant performance cost.

pub fn read<P: AsRef<Path>>(&mut self, path: P) -> Result<Arc<Vec<u8>>>

Read a file from the VFS, or the underlying backend if it isn’t resident.

Roughly equivalent to std::fs::read.

pub fn write<P: AsRef<Path>, C: AsRef<[u8]>>(
    &mut self,
    path: P,
    contents: C
) -> Result<()>

Write a file to the VFS and the underlying backend.

Roughly equivalent to std::fs::write.

pub fn read_dir<P: AsRef<Path>>(&mut self, path: P) -> Result<ReadDir>

Read all of the children of a directory.

Roughly equivalent to std::fs::read_dir.

pub fn remove_file<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Remove a file.

Roughly equivalent to std::fs::remove_file.

pub fn remove_dir_all<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Remove a directory and all of its descendants.

Roughly equivalent to std::fs::remove_dir_all.

pub fn metadata<P: AsRef<Path>>(&mut self, path: P) -> Result<Metadata>

Query metadata about the given path.

Roughly equivalent to std::fs::metadata.

pub fn event_receiver(&self) -> Receiver<VfsEvent>

Retrieve a handle to the event receiver for this Vfs.

pub fn commit_event(&mut self, event: &VfsEvent) -> Result<()>

Commit an event to this Vfs.