Struct LockGuard 

pub struct LockGuard { /* private fields */ }

RAII exclusive lock over a proper-lockfile-compatible lock directory.

Dropping the guard stops the mtime heartbeat (if any) and removes only the lock directory this guard created, and only while that directory is still the same filesystem identity captured at acquire time.

Implementations

impl LockGuard

pub fn acquire(target: impl AsRef<Path>) -> Result<Self, LockError>

Acquire an exclusive lock with the production default policy.

Errors

Returns LockError::Contended when another live holder owns the lock after the configured retries, or LockError::Io for non-contention filesystem failures (including failure to capture lock identity).

pub fn acquire_with( target: impl AsRef<Path>, options: &LockOptions, ) -> Result<Self, LockError>

Acquire an exclusive lock with a custom policy.

Errors

Returns LockError::Contended when another live holder owns the lock after the configured retries, or LockError::Io for non-contention filesystem failures (including failure to capture lock identity).

pub fn target(&self) -> &Path

Path the caller asked to lock (absolute, unresolved).

pub fn lock_path(&self) -> &Path

Lock directory owned by this guard.

pub fn release(self) -> Result<(), LockError>

Explicitly release the lock. Equivalent to dropping the guard.

Errors

Returns LockError::Io only when the lock directory is still owned by this guard and remove_dir fails for a reason other than not found. Ownership loss is treated as a successful no-op.

Trait Implementations

impl Debug for LockGuard

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

Formats the value using the given formatter.

impl Drop for LockGuard

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.