Struct freqfs::FileLock

impl<FE> FileLock<FE>

pub fn new<F>( cache: Arc<Cache<FE>>, path: PathBuf, contents: F, size: usize ) -> Self
where FE: From<F>,

Create a new FileLock.

pub fn path(&self) -> &Path

Borrow the Path of this FileLock.

pub fn load<F>(cache: Arc<Cache<FE>>, path: PathBuf) -> Self
where FE: From<F>,

Load a new FileLock.

pub async fn overwrite(&self, other: &Self) -> Result<(), Error>
where FE: Clone,

Replace the contents of this FileLock with those of the other FileLock, without reading from the filesystem.

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

Lock this file for reading.

pub fn try_read<F>(&self) -> Result<FileReadGuard<'_, F>, Error>
where F: FileLoad, FE: AsType<F>,

Lock this file for reading synchronously if possible, otherwise return an error.

pub async fn read_owned<F>(&self) -> Result<FileReadGuardOwned<FE, F>, Error>
where F: FileLoad, FE: AsType<F>,

Lock this file for reading.

pub fn try_read_owned<F>(&self) -> Result<FileReadGuardOwned<FE, F>, Error>
where F: FileLoad, FE: AsType<F>,

Lock this file for reading synchronously if possible, otherwise return an error.

pub async fn into_read<F>(self) -> Result<FileReadGuardOwned<FE, F>, Error>
where F: FileLoad, FE: AsType<F>,

Lock this file for reading, without borrowing.

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

Lock this file for writing.

pub fn try_write<F>(&self) -> Result<FileWriteGuard<'_, F>, Error>
where F: FileLoad, FE: AsType<F>,

Lock this file for writing synchronously if possible, otherwise return an error.

pub async fn write_owned<F>(&self) -> Result<FileWriteGuardOwned<FE, F>, Error>
where F: FileLoad, FE: AsType<F>,

Lock this file for writing.

pub fn try_write_owned<F>(&self) -> Result<FileWriteGuardOwned<FE, F>, Error>
where FE: AsType<F>,

Lock this file for writing synchronously if possible, otherwise return an error.

pub async fn into_write<F>(self) -> Result<FileWriteGuardOwned<FE, F>, Error>
where F: FileLoad, FE: AsType<F>,

Lock this file for writing, without borrowing.

pub fn try_into_write<F>(self) -> Result<FileWriteGuardOwned<FE, F>, Error>
where F: FileLoad, FE: AsType<F>,

Lock this file for writing synchronously, if possible, without borrowing.

pub async fn sync(&self) -> Result<(), Error>
where FE: for<'a> FileSave<'a>,

Back up this file’s contents to the filesystem.

Trait Implementations§

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

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<FE> !UnwindSafe for FileLock<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> 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<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.