Struct FileLock 

pub struct FileLock { /* private fields */ }

A held lock. Dropping it releases the lock.

Implementations

impl FileLock

pub async fn acquire( file: &Path, cancel: &CancellationToken, ) -> Result<FileLock, LockError>

Locks file, retrying with jittered backoff until the stale period has passed. While held, the lock is kept fresh.

pub fn acquire_blocking(file: &Path) -> Result<FileLock, LockError>

Locks file from synchronous code, as pi’s lockSync with its retries for settings.json and trust.json: ten attempts 20 ms apart, then LockError::Held. The lock is not kept fresh, so hold it only briefly.

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.