Struct FileDistributedLock 

pub struct FileDistributedLock { /* private fields */ }

A file-based distributed lock.

The lock is backed by a file in the provider’s directory. The file name is derived from the lock name with proper escaping for filesystem safety.

Implementations

impl FileDistributedLock

pub fn from_path(path: impl Into<PathBuf>) -> Result<Self, LockError>

Creates a lock for a specific file path.

Use this when you want to lock a specific file rather than using the provider’s directory.

pub fn path(&self) -> &PathBuf

Returns the path to the lock file.

Trait Implementations

impl DistributedLock for FileDistributedLock

type Handle = FileLockHandle

The handle type returned when the lock is acquired.

fn name(&self) -> &str

Returns the unique name identifying this lock.

async fn acquire(&self, timeout: Option<Duration>) -> LockResult<Self::Handle>

Acquires the lock, waiting up to timeout.

async fn try_acquire(&self) -> LockResult<Option<Self::Handle>>

Attempts to acquire the lock without waiting.