Struct Lock 

pub struct Lock { /* private fields */ }

A held advisory lock. Dropping it releases the lock.

Implementations

impl Lock

pub fn acquire( path: &Utf8Path, mode: Mode, purpose: &str, ) -> Result<Self, AppError>

Take the lock at path, or refuse naming its holder.

Errors

AppError::Busy when another process holds it, and I/O errors when the lock file cannot be created.

pub fn exclusive(path: &Utf8Path, purpose: &str) -> Result<Self, AppError>

Take the lock alone.

Errors

As Lock::acquire.

pub fn exclusive_waiting( path: &Utf8Path, purpose: &str, budget: Duration, ) -> Result<Self, AppError>

Take the lock alone, waiting a bounded time for a holder to leave.

For a lock whose critical section is short and whose contention is ordinary rather than exceptional: two operators planning at once should queue, not fail. The bound keeps a dead holder from hanging a command, so a wait that runs out still refuses and names it.

Errors

AppError::Busy when the wait runs out, and I/O errors when the lock file cannot be created.

pub fn shared(path: &Utf8Path, purpose: &str) -> Result<Self, AppError>

Take the lock beside other readers.

Errors

As Lock::acquire.

pub const fn mode(&self) -> Mode

Whether this lock excludes other readers.

Trait Implementations

impl Debug for Lock

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

Formats the value using the given formatter.

impl Drop for Lock

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.