Struct LockOptions

pub struct LockOptions<'pb> { /* private fields */ }

Provides options for creating a FileLock

Implementations

impl<'pb> LockOptions<'pb>

pub fn new(path: &'pb Path) -> Self

Creates a new Self for the specified path

pub fn cargo_package_lock(root: Option<PathBuf>) -> Result<Self, Error>

Creates a new Self for locking cargo’s global package lock

If specified, the path is used as the root, otherwise it is rooted at the path determined by $CARGO_HOME

pub fn shared(self) -> Self

Will attempt to acquire a shared lock rather than an exclusive one

pub fn exclusive(self, shared_fallback: bool) -> Self

Will attempt to acquire an exclusive lock, which can optionally fallback to a shared lock if the lock file is for a read only filesystem

pub fn try_lock(&self) -> Result<FileLock, Error>

Attempts to acquire a lock, but fails immediately if the lock is currently held

pub fn lock( &self, wait: impl Fn(&Path) -> Option<Duration>, ) -> Result<FileLock, Error>

Attempts to acquire a lock, waiting if the lock is currently held.

Unlike Self::try_lock, if the lock is currently held, the specified callback is called to inform the caller that a wait is about to be performed, then waits for the amount of time specified by the return of the callback, or infinitely in the case of None.