Struct FileLock 

pub struct FileLock { /* private fields */ }

RAII guard around an advisory lock on a sidecar lock file.

The lock is released when the guard is dropped (and, as a backstop, by the operating system when the process exits — so a crashed writer never leaves a database permanently locked).

Implementations

impl FileLock

pub fn acquire<P: AsRef<Path>>( lock_path: P, mode: LockMode, ) -> Result<Self, LinkError>

Acquires the lock, blocking until it becomes available.

pub fn try_acquire<P: AsRef<Path>>( lock_path: P, mode: LockMode, ) -> Result<Option<Self>, LinkError>

Tries to acquire the lock, returning Ok(None) when another holder currently owns a conflicting lock.

pub fn path(&self) -> &Path

The sidecar lock file this guard holds.

pub fn mode(&self) -> LockMode

The sharing mode this guard was acquired with.

Trait Implementations

impl Debug for FileLock

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

Formats the value using the given formatter.

impl Drop for FileLock

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.