Struct freqfs::FileLock

source · [−]

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

Expand description

A clone-able wrapper over a tokio::sync::RwLock on a file container.

Implementations

source

pub async fn read<F>(&self) -> Result<FileReadGuard<FE, F>, Error> where
FE: FileLoad + AsType<F>,

Lock this file for reading.

source

pub async fn write<F>(&self) -> Result<FileWriteGuard<FE, F>, Error> where
FE: FileLoad + AsType<F>,

Lock this file for writing.

source

pub async fn sync(&self, err_if_locked: bool) -> Result<(), Error> where
FE: FileLoad,

Back up this file’s contents to the filesystem.

This method acquires a write lock on the file contents, so it can deadlock if there is already a lock on the file contents.

Pass true to error out if there is already a lock on the file contents.

Trait Implementations

source

impl<FE> Clone for FileLock<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 FileLock<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 FileLock<FE>

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

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

impl<FE> Unpin for FileLock<FE>

impl<FE> !UnwindSafe for FileLock<FE>

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

source

pub 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

pub 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

pub fn cast_into(self) -> F

Cast an instance of Self into an instance of T.

source

impl<T> From<T> for T

source

pub fn from(t: T) -> T

Performs the conversion.

source

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

source

pub fn into(self) -> U

Performs the conversion.

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

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

pub fn can_cast_from(&F) -> bool

Test if value can be cast into Self.

source

pub 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

pub fn can_cast_into(&self) -> bool

Test if self can be cast into T.

source

pub 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

Struct freqfs::FileLock

Implementations

impl<FE> FileLock<FE>

pub fn path(&self) -> &Path

pub async fn size_hint(&self) -> Option<usize>

pub async fn read<F>(&self) -> Result<FileReadGuard<FE, F>, Error> where FE: FileLoad + AsType<F>,

pub async fn write<F>(&self) -> Result<FileWriteGuard<FE, F>, Error> where FE: FileLoad + AsType<F>,

pub async fn sync(&self, err_if_locked: bool) -> Result<(), Error> where FE: FileLoad,

Trait Implementations

impl<FE> Clone for FileLock<FE>

fn clone(&self) -> Self

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

impl<FE> Debug for FileLock<FE>

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

Auto Trait Implementations

impl<FE> !RefUnwindSafe for FileLock<FE>

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

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

impl<FE> Unpin for FileLock<FE>

impl<FE> !UnwindSafe for FileLock<FE>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

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

pub fn cast_from(f: F) -> T

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

pub fn cast_into(self) -> F

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<F> Match for F

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

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

pub fn can_cast_from(&F) -> bool

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

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

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

pub fn can_cast_into(&self) -> bool

pub fn opt_cast_into(self) -> Option<T>

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

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

type Error = Infallible

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

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

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

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

pub async fn read<F>(&self) -> Result<FileReadGuard<FE, F>, Error> where
FE: FileLoad + AsType<F>,

pub async fn write<F>(&self) -> Result<FileWriteGuard<FE, F>, Error> where
FE: FileLoad + AsType<F>,

pub async fn sync(&self, err_if_locked: bool) -> Result<(), Error> where
FE: FileLoad,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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