Struct FileLock 

pub struct FileLock { /* private fields */ }

An exclusive file lock (RAII guard).

The lock is released when this value is dropped (the underlying file descriptor / handle is closed, which releases the lock).

Implementations

impl FileLock

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

Acquire an exclusive lock on path, blocking until available.

If the lock file does not exist, it is created.

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

Try to acquire an exclusive lock without blocking.

Returns Ok(None) if the lock is held by another process.

pub fn path(&self) -> &Path

Path of the lock file.

Trait Implementations

impl Drop for FileLock

fn drop(&mut self)

Executes the destructor for this type.