Struct LockedFile 

pub struct LockedFile(/* private fields */);

A file lock that is automatically released when dropped.

Implementations

impl LockedFile

pub fn acquire_blocking( path: impl AsRef<Path>, resource: impl Display, ) -> Result<Self, Error>

The same as [LockedFile::acquire], but for synchronous contexts.

Do not use from an async context, as this can block the runtime while waiting for another process to release the lock.

pub fn acquire_shared_blocking( path: impl AsRef<Path>, resource: impl Display, ) -> Result<Self, Error>

The same as LockedFile::acquire_blocking, but for synchronous contexts.

Do not use from an async context, as this can block the runtime while waiting for another process to release the lock.

pub fn acquire_no_wait( path: impl AsRef<Path>, resource: impl Display, ) -> Option<Self>

Acquire a cross-process lock for a resource using a file at the provided path

Unlike [LockedFile::acquire] this function will not wait for the lock to become available.

If the lock is not immediately available, None is returned.

Trait Implementations

impl Debug for LockedFile

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

Formats the value using the given formatter.

impl Drop for LockedFile

fn drop(&mut self)

Executes the destructor for this type.