Struct ProcessLock 

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

An exclusive OS file lock, released when this value is dropped.

Every participant must use the same persistent path in an application-owned directory. Neither this type nor a caller may unlink or replace the lock file: another process could still hold a lock on the original inode. Keep this guard alive through endpoint cleanup and the work it protects. Use separate paths for daemon ownership and upgrade serialization.

Implementations

impl ProcessLock

pub fn try_acquire(path: impl AsRef<Path>) -> Result<Option<Self>>

Acquire without waiting, creating the file if necessary.

Returns Ok(None) only for contention; filesystem and locking failures remain errors. The parent directory must already exist.

pub fn try_from_file(file: File) -> Result<Option<Self>>

Lock an already-open file. This preserves a consumer’s secure open policy.

pub fn is_held(path: impl AsRef<Path>) -> Result<bool>

Observe an existing lock without creating a file. Only contention is true.

Trait Implementations

impl Debug for ProcessLock

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

Formats the value using the given formatter.

impl Drop for ProcessLock

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.