Struct FileLock 

pub struct FileLock {
    pub recovered_stale: Option<LockOwner>,
    /* private fields */
}

Held until dropped (or the process dies).

Fields

recovered_stale: Option<LockOwner>

Owner of a lock left behind by a process that is gone, when one was found.

Implementations

impl FileLock

pub fn acquire(path: &Path, options: &LockOptions) -> Result<Self>

Exclusive lock, the first of the two lock primitives. Waits up to options.timeout (Duration::ZERO tries once), then records this process as owner in <path>.owner. Returns FsError::Locked (with the owner) or FsError::LockTimeout when busy.

pub fn try_acquire(path: &Path) -> Result<Self>

Exclusive lock, failing immediately when busy. Shorthand for acquire with default options.

pub fn acquire_shared(path: &Path, options: &LockOptions) -> Result<Self>

Shared lock, the second primitive: any number of shared holders may coexist, and an exclusive holder excludes them all. Waits up to options.timeout. Writes no owner record, so recovered_stale is always None.

pub fn path(&self) -> &Path

pub fn current_owner(lock_path: &Path) -> Option<LockOwner>

The holder recorded on disk for lock_path (diagnostics; may be stale).

Trait Implementations

impl Debug for FileLock

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

Formats the value using the given formatter.

impl Drop for FileLock

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.