Struct grebedb::vfs::OsVfs

pub struct OsVfs { /* fields omitted */ }

Interface to a real file system on disk.

Implementations

impl OsVfs

pub fn new<P>(root: P) -> Self where
    P: Into<PathBuf>, 

Create a file system interface to the given path.

The given path is treated as the root for subsequent relative path operations.

Trait Implementations

impl Debug for OsVfs

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

Formats the value using the given formatter.

impl Vfs for OsVfs

fn lock(&mut self, path: &str) -> Result<(), Error>

Lock the file preventing other processes from accessing it.

fn unlock(&mut self, path: &str) -> Result<(), Error>

Unlock the file.

fn read(&self, path: &str) -> Result<Vec<u8>, Error>

Read the contents of a file to a vector.

fn write(
    &mut self,
    path: &str,
    data: &[u8],
    sync_option: VfsSyncOption
) -> Result<(), Error>

Write the contents to a file.

fn remove_file(&mut self, path: &str) -> Result<(), Error>

Delete a file.

fn read_dir(&self, path: &str) -> Result<Vec<String>, Error>

Return a vector of filenames in a directory.

fn create_dir(&mut self, path: &str) -> Result<(), Error>

Create a directory at the given path.

fn remove_dir(&mut self, path: &str) -> Result<(), Error>

Remove an empty directory.

fn rename_file(&mut self, old_path: &str, new_path: &str) -> Result<(), Error>

Rename a file.

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

Return whether the path is a directory.

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

Return whether the path exists.

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

Create directories for all components of the path if they do not exist.

fn remove_empty_dir_all(&mut self, path: &str) -> Result<(), Error>

Remove empty directories in the path if they exist.