Struct cargo::util::cache_lock::CacheLocker

pub struct CacheLocker { /* private fields */ }

A locker that can be used to acquire locks.

See the crate::util::cache_lock module documentation for an overview of how cache locking works.

Implementations

impl CacheLocker

pub fn new() -> CacheLocker

Creates a new CacheLocker.

pub fn lock( &self, gctx: &GlobalContext, mode: CacheLockMode ) -> CargoResult<CacheLock<'_>>

Acquires a lock with the given mode, possibly blocking if another cargo is holding the lock.

pub fn try_lock( &self, gctx: &GlobalContext, mode: CacheLockMode ) -> CargoResult<Option<CacheLock<'_>>>

Acquires a lock with the given mode, returning None if another cargo is holding the lock.

pub fn is_locked(&self, mode: CacheLockMode) -> bool

Returns whether or not a lock is held for the given mode in this locker.

This does not tell you whether or not it is locked in some other locker (such as in another process).

Note that Shared will return true if a MutateExclusive lock is held, since MutateExclusive is just an upgraded Shared. Likewise, DownlaodExclusive will return true if a MutateExclusive lock is held since they overlap.

Trait Implementations

impl Debug for CacheLocker

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

Formats the value using the given formatter.