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; waits up to options.timeout.

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

Fail immediately when busy.

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

Shared (reader) lock: many readers, excluded by a writer. No owner record.

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.