Struct FileLock 

pub struct FileLock { /* private fields */ }

A held lock; released when dropped.

Implementations

impl FileLock

pub fn try_acquire(path: &Path) -> Result<Self, LockError>

Try once; returns LockError::Held if a live holder has the lock.

pub fn acquire_with_wait( path: &Path, budget: Duration, ) -> Result<Self, LockError>

Block until the lock is acquired, a stale holder is taken over, or budget elapses.

pub fn path_key(path: &Path) -> String

Filesystem-safe digest of a path for lock file names.

pub fn stripe_lock_path(definition_dir: &Path) -> PathBuf

{state_dir}/locks/stripe/{digest}.lock for a definition dir.

pub fn git_cache_lock_path(cache_key: &str) -> PathBuf

{state_dir}/locks/git-cache/{cache_key}.lock.

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.