Struct FileLock 

pub struct FileLock {
    pub path: PathBuf,
    /* private fields */
}

RAII advisory file lock.

The lock is automatically released when this struct is dropped. Uses advisory locking via std, which works across processes on Unix systems.

Fields

path: PathBuf

Implementations

impl FileLock

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

Acquire an exclusive lock, blocking until available.

Creates the lock file and parent directories if they don’t exist.

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

Try to acquire an exclusive lock without blocking.

Returns Ok(Some(lock)) if the lock was acquired, Ok(None) if the lock is held by another process, or an error for other failures.