# Struct cargo::util::cache_lock::RecursiveLock

source ·

    struct RecursiveLock {
        lock: Option<FileLock>,
        count: u32,
        is_exclusive: bool,
        filename: &'static str,
    }

Expand description

A file lock, with a counter to assist with recursive locking.

## Fields§

§`lock: Option<FileLock>`

The file lock.

An important note is that locks can be `None` even when they are held. This can happen on things like old NFS mounts where locking isn’t supported. We otherwise pretend we have a lock via the lock count. See `FileLock` for more detail on that.

§`count: u32`

Number locks held, to support recursive locking.

§`is_exclusive: bool`

If this is `true`, it is an exclusive lock, otherwise it is shared.

§`filename: &'static str`

The filename of the lock.

## Implementations§

source§

### impl RecursiveLock

source

#### fn new(filename: &'static str) -> RecursiveLock

source

#### fn increment(&mut self)

Low-level lock count increment routine.

source

#### fn decrement(&mut self)

Unlocks a previously acquired lock.

source

#### fn lock_shared( &mut self, gctx: &GlobalContext, description: &'static str, blocking: BlockingMode ) -> LockingResult

Acquires a shared lock.

source

#### fn lock_shared_blocking( &mut self, gctx: &GlobalContext, description: &'static str )

Acquires a shared lock, blocking if held by another locker.

source

#### fn lock_shared_nonblocking(&mut self, gctx: &GlobalContext) -> LockingResult

Acquires a shared lock, returns `WouldBlock` if held by another locker.

source

#### fn lock_exclusive( &mut self, gctx: &GlobalContext, description: &'static str, blocking: BlockingMode ) -> CargoResult<LockingResult>

Acquires an exclusive lock.

source

#### fn lock_exclusive_blocking( &mut self, gctx: &GlobalContext, description: &'static str ) -> CargoResult<()>

Acquires an exclusive lock, blocking if held by another locker.

source

#### fn lock_exclusive_nonblocking( &mut self, gctx: &GlobalContext ) -> CargoResult<LockingResult>

Acquires an exclusive lock, returns `WouldBlock` if held by another locker.

## Trait Implementations§

source§

### impl Debug for RecursiveLock

source§

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### impl Freeze for RecursiveLock

§

### impl RefUnwindSafe for RecursiveLock

§

### impl Send for RecursiveLock

§

### impl Sync for RecursiveLock

§

### impl Unpin for RecursiveLock

§

### impl UnwindSafe for RecursiveLock

## Blanket Implementations§

source§

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

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for T
where T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for T
where 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 T
where 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.

§

### impl<T> Pointable for T

§

#### const ALIGN: usize = _

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
source§

### impl<T, U> TryFrom<U> for T
where 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 T
where 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 T
where 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: 56 bytes