Struct Dir

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

A transactional directory

Implementations

impl<FE: ThreadSafe + Clone> Dir<FE>

pub fn into_inner(self) -> Inner<FE>

Destructure this Dir into its underlying freqfs::DirLock.

pub async fn contains(&self, txn_id: TxnId, name: &Id) -> TCResult<bool>

Check whether this Dir has an entry with the given name at txn_id.

pub async fn delete(&self, txn_id: TxnId, name: Id) -> TCResult<bool>

Delete the given entry from this Dir, if present at txn_id.

pub async fn entry_names( &self, txn_id: TxnId, ) -> TCResult<impl Iterator<Item = Key>>

Iterate over the names of the entries in this Dir at txn_id.

pub async fn files<B>( &self, txn_id: TxnId, ) -> TCResult<impl Iterator<Item = (Key, File<FE, B>)>>

Iterate over each DirEntry in this Dir at txn_id, assuming it is a File.

pub async fn get_dir(&self, txn_id: TxnId, name: &Id) -> TCResult<Self>

Get the sub-Dir with the given name at txn_id, or return a “not found” error.

pub async fn get_file<B>( &self, txn_id: TxnId, name: &Id, ) -> TCResult<File<FE, B>>

where B: GetSize + Clone, FE: AsType<B>,

Get the File with the given name at txn_id, or return a “not found” error.

pub async fn is_empty(&self, txn_id: TxnId) -> TCResult<bool>

Return true if this Dir is empty at txn_id.

pub async fn entries<B>( &self, txn_id: TxnId, ) -> TCResult<impl Stream<Item = TCResult<(Key, DirEntry<FE, B>)>> + Unpin + Send + '_>

Construct a Stream of the DirEntrys in this Dir at txn_id.

pub async fn trim(&self, txn_id: TxnId) -> TCResult<()>

Delete any empty entries in this Dir at txn_id.

impl<FE> Dir<FE>

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

pub async fn load(txn_id: TxnId, canon: DirLock<FE>) -> TCResult<Self>

Load a transactional Dir from the filesystem cache.

pub async fn create_dir(&self, txn_id: TxnId, name: Id) -> TCResult<Self>

Create a new sub-directory with the given name at txn_id.

pub async fn create_file<B>( &self, txn_id: TxnId, name: Id, ) -> TCResult<File<FE, B>>

where B: GetSize + Clone, FE: AsType<B>,

Create a new File with the given name at txn_id.

pub async fn get_or_create_dir(&self, txn_id: TxnId, name: Id) -> TCResult<Self>

Get the sub-Dir with the given name at txn_id, or create a new one.

impl<FE: ThreadSafe + Clone + for<'a> FileSave<'a>> Dir<FE>

pub async fn commit(&self, txn_id: TxnId, recursive: bool)

Commit this Dir at txn_id.

pub async fn rollback(&self, txn_id: TxnId, recursive: bool)

Roll back this Dir at txn_id.

pub async fn finalize(&self, txn_id: TxnId)

Finalize this Dir at txn_id.

Trait Implementations

impl<FE> Clone for Dir<FE>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<FE> Debug for Dir<FE>

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

Formats the value using the given formatter.