Struct freqfs::DirLock

source ·
pub struct DirLock<FE> { /* private fields */ }
Expand description

A clone-able wrapper type over a RwLock on a directory.

Implementations§

source§

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

source

pub async fn read(&self) -> DirReadGuard<'_, FE>

Lock this directory for reading.

source

pub async fn into_read(self) -> DirReadGuardOwned<FE>

Lock this directory for reading, without borrowing.

source

pub fn try_read(&self) -> Result<DirReadGuard<'_, FE>, Error>

Lock this directory for reading synchronously, if possible.

source

pub async fn read_owned(&self) -> DirReadGuardOwned<FE>

Lock this directory for reading.

source

pub fn try_read_owned(&self) -> Result<DirReadGuardOwned<FE>, Error>

Lock this directory for reading synchronously, if possible.

source

pub async fn write(&self) -> DirWriteGuard<'_, FE>

Lock this directory for writing.

source

pub async fn write_owned(&self) -> DirWriteGuardOwned<FE>

Lock this directory for writing.

source

pub async fn into_write(self) -> DirWriteGuardOwned<FE>

Lock this directory for writing, without borrowing.

source

pub fn try_write(&self) -> Result<DirWriteGuard<'_, FE>, Error>

Lock this directory for writing synchronously, if possible.

source

pub fn try_write_owned(&self) -> Result<DirWriteGuardOwned<FE>, Error>

Lock this directory for writing synchronously, if possible.

source

pub fn sync( &self ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>>
where FE: for<'a> FileSave<'a>,

Synchronize the contents of this directory with the filesystem.

source

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

Recursively delete empty entries in this Dir. Returns the number of entries in this Dir.

Trait Implementations§

source§

impl<FE> Clone for DirLock<FE>

source§

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
source§

impl<FE> Debug for DirLock<FE>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<FE> !RefUnwindSafe for DirLock<FE>

§

impl<FE> Send for DirLock<FE>
where FE: Send + Sync,

§

impl<FE> Sync for DirLock<FE>
where FE: Send + Sync,

§

impl<FE> Unpin for DirLock<FE>

§

impl<FE> !UnwindSafe for DirLock<FE>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

fn cast_from(f: F) -> T

Cast an instance of T into an instance of Self.
source§

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

source§

fn cast_into(self) -> F

Cast an instance of Self into an instance of T.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<F> Match for F

source§

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

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

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

source§

fn can_cast_from(_: &F) -> bool

Test if value can be cast into Self.
source§

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

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

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.
source§

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

source§

fn can_cast_into(&self) -> bool

Test if self can be cast into T.
source§

fn opt_cast_into(self) -> Option<T>

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

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.
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.