Struct freqfs::Dir

pub struct Dir<FE> { /* private fields */ }

A filesystem directory

Implementations

impl<FE: FileLoad> Dir<FE>

pub fn path(&self) -> &Path

Borrow the Path of this Dir.

pub fn contains<N: Borrow<str>>(&self, name: N) -> bool

Return true if this Dir has an entry with the given name.

pub fn create_dir(&mut self, name: String) -> Result<DirLock<FE>, Error>

Create and return a new subdirectory of this Dir.

pub fn get_or_create_dir(&mut self, name: String) -> Result<DirLock<FE>, Error>

Return a new subdirectory of this Dir, creating it if it doesn’t already exist.

pub fn get<Q: Eq + Hash + ?Sized>(&self, name: &Q) -> Option<&DirEntry<FE>>where
    String: Borrow<Q>,

Get the entry with the given name from this Dir.

pub fn get_dir<Q: Eq + Hash + ?Sized>(&self, name: &Q) -> Option<&DirLock<FE>>where
    String: Borrow<Q>,

Get the subdirectory with the given name from this Dir, if present.

Also returns None if the entry at name is a file.

pub fn get_file<Q: Eq + Hash + ?Sized>(&self, name: &Q) -> Option<FileLock<FE>>where
    String: Borrow<Q>,

Get the file with the given name from this Dir, if present.

Also returns None if the entry at name is a directory.

pub fn is_empty(&self) -> bool

Return true if this Dir contains no entries.

pub fn iter(&self) -> impl Iterator<Item = (&String, &DirEntry<FE>)>

Return an Iterator over the entries in this Dir.

pub fn len(&self) -> usize

Return the number of entries in this Dir.

impl<FE: FileLoad> Dir<FE>

pub fn create_file<F>(
    &mut self,
    name: String,
    contents: F,
    size: usize
) -> Result<FileLock<FE>, Error>where
    FE: From<F>,

Create a new file in this Dir with the given contents.

pub fn delete(
    &mut self,
    name: String
) -> Pin<Box<dyn Future<Output = bool> + Send + '_>>

Delete the entry with the given name from this Dir.

Returns true if there was an entry present.

References to sub-directories and files remain valid even after deleting their parent directory, so writing to a file after deleting its parent directory will re-create the directory on the filesystem, and sync’ing the parent directory will delete the file.

Make sure to call sync to delete any contents on the filesystem if it’s possible for an new entry with the same name to be created later. Alternately, call Dir::delete_and_sync.

pub fn delete_and_sync(
    &mut self,
    name: String
) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + '_>>

Delete the entry with the given name from this Dir and the filesystem.

Returns true if there was an entry present.

pub fn sync(
    &mut self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>>

Synchronize the contents of this directory with the filesystem.

This will create new subdirectories and delete entries from the filesystem, but will NOT synchronize the contents of any child directories or files.

Trait Implementations

impl<FE> Debug for Dir<FE>

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

Formats the value using the given formatter.