pub struct CacheLocker {
    state: RefCell<CacheState>,
}
Expand description

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.

Fields§

§state: RefCell<CacheState>

The state of the locker.

CacheLocker uses interior mutability because it is stuffed inside the global Config, which does not allow mutation.

Implementations§

source§

impl CacheLocker

source

pub fn new() -> CacheLocker

Creates a new CacheLocker.

source

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

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

source

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

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

source

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§

source§

impl Debug for CacheLocker

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 120 bytes