Struct tc_transact::fs::Dir

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

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

Load a transactional Dir from the filesystem cache.

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 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( &self, txn_id: TxnId, name: Id ) -> TCResult<File<FE, B>>
where B: GetSize + Clone, FE: AsType,

Create a new File with the given name 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( &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_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.

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

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( &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: 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. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<FE> Debug for Dir<FE>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<FE> !UnwindSafe for Dir<FE>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<F, T> CastFrom<F> for T
where T: From<F>,

fn cast_from(f: F) -> T

Cast an instance of T into an instance of Self.

impl<T, F> CastInto<F> for T
where F: CastFrom<T>,

fn cast_into(self) -> F

Cast an instance of Self into an instance of T.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<F> Match for F

fn matches<T>(&self) -> bool
where T: TryCastFrom<Self>,

Returns true if self can be cast into the target type T.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<State, T> ToState<State> for T
where State: StateInstance, T: Clone + Into<State>,

fn to_state(&self) -> State

impl<F, T> TryCastFrom<F> for T
where T: CastFrom<F>,

fn can_cast_from(_: &F) -> bool

Test if value can be cast into Self.

fn opt_cast_from(f: F) -> Option<T>

Returns Some(Self) if the source value can be cast into Self, otherwise None.

fn try_cast_from<Err, OnErr>(value: T, on_err: OnErr) -> Result<Self, Err>
where OnErr: FnOnce(&T) -> Err,

Returns Ok(Self) if the source value can be cast into Self, otherwise calls on_err.

impl<F, T> TryCastInto<T> for F
where T: TryCastFrom<F>,

fn can_cast_into(&self) -> bool

Test if self can be cast into T.

fn opt_cast_into(self) -> Option<T>

Returns Some(T) if self can be cast into T, otherwise None.

fn try_cast_into<Err, OnErr>(self, on_err: OnErr) -> Result<T, Err>
where OnErr: FnOnce(&Self) -> Err,

Returns Ok(T) if self can be cast into T, otherwise calls on_err.

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V