ReentrantLockGuard in std::sync - Rust
Description: An RAII implementation of a “scoped lock” of a re-entrant lock. When this structure is dropped (falls out of scope), the lock will be unlocked.

## ReentrantLockGuard

# Struct ReentrantLockGuard

Source

    pub struct ReentrantLockGuard<'a, T: ?Sized + 'a> { /* private fields */ }

🔬This is a nightly-only experimental API. (`reentrant_lock` #121440)
Expand description

An RAII implementation of a “scoped lock” of a re-entrant lock. When this structure is dropped (falls out of scope), the lock will be unlocked.

The data protected by the mutex can be accessed through this guard via its `Deref` implementation.

This structure is created by the `lock` method on `ReentrantLock`.

## §Mutability

Unlike `MutexGuard`, `ReentrantLockGuard` does not implement `DerefMut`, because implementation of the trait would violate Rust’s reference aliasing rules. Use interior mutability (usually `RefCell`) in order to mutate the guarded data.

## Trait Implementations§

Source§

### impl<T: Debug + ?Sized> Debug for ReentrantLockGuard<'_, T>

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl<T: ?Sized> Deref for ReentrantLockGuard<'_, T>

Source§

#### type Target = T

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

### impl<T: Display + ?Sized> Display for ReentrantLockGuard<'_, T>

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl<T: ?Sized> Drop for ReentrantLockGuard<'_, T>

Source§

#### fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

### impl<T: ?Sized> !Send for ReentrantLockGuard<'_, T>

Source§

### impl<T: ?Sized + Sync> Sync for ReentrantLockGuard<'_, T>

## Auto Trait Implementations§

§

### impl<'a, T> Freeze for ReentrantLockGuard<'a, T>
where T: ?Sized,

§

### impl<'a, T> RefUnwindSafe for ReentrantLockGuard<'a, T>
where T: RefUnwindSafe + ?Sized,

§

### impl<'a, T> Unpin for ReentrantLockGuard<'a, T>
where T: ?Sized,

§

### impl<'a, T> UnwindSafe for ReentrantLockGuard<'a, T>
where T: RefUnwindSafe + ?Sized,

## 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.

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.

Source§

### impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

#### type Target = T

🔬This is a nightly-only experimental API. (`arbitrary_self_types` #44874)
The target type on which the method may be called.
Source§

### impl<T> ToString for T
where T: Display + ?Sized,

Source§

#### fn to_string(&self) -> String

Converts the given value to a `String`. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### 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>,

Source§

#### 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.