Struct AsyncLockFile

pub struct AsyncLockFile { /* private fields */ }

An async LockFile.

Implemented by blocking on the tokio threadpool

Implementations

impl AsyncLockFile

pub async fn open<P>(path: P) -> Result<Self>

where P: IntoOsString,

Open a file for locking

pub fn blocking_open<P>(path: &P) -> Result<Self>

where P: ToOsStr + ?Sized,

Open a file for locking in a blocking manner

pub async fn lock(&self) -> Result<()>

Lock the file

pub async fn lock_with_pid(&self) -> Result<()>

Lock the file, writing the PID to it

pub async fn try_lock(&self) -> Result<bool>

Try to lock the file, returning true if successful.

pub async fn try_lock_with_pid(&self) -> Result<bool>

Try to lock a file with a pid, returning true if successful.

pub fn try_lock_with_pid_blocking(&self) -> Result<bool>

Try to lock a file with a pid, returning true if successful in a blocking manner.

pub async fn owns_lock(&self) -> Result<bool>

Returns true if this owns the lock

pub async fn unlock(&self) -> Result<()>

Unlock the file

pub fn blocking_unlock(&self) -> Result<()>

Unlock the file in a blocking manner

Trait Implementations

impl Clone for AsyncLockFile

fn clone(&self) -> AsyncLockFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AsyncLockFile

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

Formats the value using the given formatter.