Struct freqfs::FileLock[−][src]

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

Expand description

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

Implementations

[src]

impl<FE> FileLock<FE>

[src]

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

Lock this file for reading.

[src]

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

Lock this file for writing.

[src]

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

[src]

impl<FE> Clone for FileLock<FE>

[src]

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. 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

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

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

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

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

[src]

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

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

recently added

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

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

Struct freqfs::FileLock[−][src]

Implementations

impl<FE> FileLock<FE>

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

pub async fn write<F>(&self) -> Result<FileWriteGuard<FE, F>, Error> where
FE: FileLoad + FileEntry<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)

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

Struct freqfs::FileLock[−][src]

Implementations

impl<FE> FileLock<FE>

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

pub async fn write<F>(&self) -> Result<FileWriteGuard<FE, F>, Error> where FE: FileLoad + FileEntry<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)

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<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<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<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 + FileEntry<F>,

pub async fn write<F>(&self) -> Result<FileWriteGuard<FE, F>, Error> where
FE: FileLoad + FileEntry<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<T, U> Into<U> for T where
U: From<T>,

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

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

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