Struct freqfs::Dir

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

A filesystem directory

Implementations

impl<FE: Send + Sync> Dir<FE>

pub fn path(&self) -> &Path

Borrow the Path of this Dir.

pub fn contains<Q: Name + Display + ?Sized>(&self, name: &Q) -> 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 create_dir_unique(&mut self) -> Result<(Uuid, DirLock<FE>), Error>

Create and return a new subdirectory of this Dir with a unique name.

pub fn entries(&self) -> impl Iterator<Item = &DirEntry<FE>>

Return an Iterator over the entries in this Dir.

pub fn files(&self) -> impl Iterator<Item = &FileLock<FE>>

Return an Iterator over the file entries in 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: Name + ?Sized>(&self, name: &Q) -> Option<&DirEntry<FE>>

Get the entry with the given name from this Dir.

pub fn get_dir<Q: Name + ?Sized>(&self, name: &Q) -> Option<&DirLock<FE>>

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: Name + ?Sized>(&self, name: &Q) -> Option<&FileLock<FE>>

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.

pub fn names(&self) -> impl Iterator<Item = &String>

Return an Iterator over the names of the entries in this Dir.

pub async fn read_file<Q, F>( &self, name: &Q ) -> Result<FileReadGuard<'_, F>, Error>

where Q: Name + Display + ?Sized, F: FileLoad, FE: AsType<F>,

Convenience method to lock a file for reading. Returns a “not found” error if the there is no file with the given name.

pub async fn read_file_owned<Q, F>( &self, name: &Q ) -> Result<FileReadGuardOwned<FE, F>, Error>

where Q: Name + Display + ?Sized, F: FileLoad, FE: AsType<F>,

Convenience method to lock a file for reading. Returns a “not found” error if the there is no file with the given name.

pub async fn write_file<Q, F>( &self, name: &Q ) -> Result<FileWriteGuard<'_, F>, Error>

where Q: Name + Display + ?Sized, F: FileLoad, FE: AsType<F>,

Convenience method to lock a file for writing. Returns a “not found” error if the there is no file with the given name.

pub async fn write_file_owned<Q, F>( &self, name: &Q ) -> Result<FileWriteGuardOwned<FE, F>, Error>

where Q: Name + Display + ?Sized, F: FileLoad, FE: AsType<F>,

Convenience method to lock a file for writing. Returns a “not found” error if the there is no file with the given name.

impl<FE: Send + Sync> 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 create_file_unique<F>( &mut self, contents: F, size: usize ) -> Result<(Uuid, FileLock<FE>), Error>

where FE: From<F>,

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

pub fn copy_dir_from<'a>( &'a mut self, name: String, source: &'a DirLock<FE> ) -> Pin<Box<dyn Future<Output = Result<DirLock<FE>, Error>> + Send + 'a>>

where FE: Clone,

Create or overwrite the directory at name by copying from source, without necessarily loading its contents into the cache.

pub async fn copy_file_from( &mut self, name: String, source: &FileLock<FE> ) -> Result<FileLock<FE>, Error>

where FE: Clone,

Create or overwrite the file at name by copying from source, without necessarily loading source into the cache.

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

where Q: Name + Send + Sync + ?Sized,

Delete the entry with the given name from this Dir.

Returns true if there was an entry present.

This will cause a deadlock if there are still active references to the deleted entry of this directory, i.e. if a lock cannot be acquired any child to delete (recursively)!

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

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

where FE: for<'a> FileSave<'a>,

Synchronize the contents of this directory with the filesystem.

pub fn truncate<'a>( &'a mut self ) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>>

Delete all entries from this Dir.

This will cause a deadlock if there are still active references to the contents of this directory, i.e. if a lock cannot be acquired on any child of this Dir (recursively)!

Make sure to call Dir::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::truncate_and_sync.

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

Delete all entries from this Dir on the filesystem.

This will cause a deadlock if there are still active references to the contents of this directory, i.e. if a lock cannot be acquired on any child of this Dir (recursively)!

Trait Implementations

impl<FE> Debug for Dir<FE>

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

Formats the value using the given formatter.