Struct FileLock 

pub struct FileLock { /* private fields */ }

A file lock for coordinating concurrent access to shared files.

Uses a .lock file alongside the target file for locking. This avoids issues with locking the target file directly (which can interfere with truncation/replacement).

Implementations

impl FileLock

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

Creates a new file lock for the given path.

The lock file is created at {path}.lock. The parent directory is created if it doesn’t exist.

pub fn shared(&self) -> Result<LockGuard>

Acquires a shared (read) lock.

Multiple processes can hold shared locks simultaneously. Blocks until the lock is available.

pub fn try_shared(&self) -> Result<Option<LockGuard>>

Tries to acquire a shared (read) lock without blocking.

Returns Ok(None) if the lock is not available.

pub fn exclusive(&self) -> Result<LockGuard>

Acquires an exclusive (write) lock.

Only one process can hold an exclusive lock. Blocks until the lock is available.

pub fn try_exclusive(&self) -> Result<Option<LockGuard>>

Tries to acquire an exclusive (write) lock without blocking.

Returns Ok(None) if the lock is not available.

pub fn lock_path(&self) -> &Path

Returns the path to the lock file.

Trait Implementations

impl Debug for FileLock

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

Formats the value using the given formatter.