Struct RwLockWriteGuard

pub struct RwLockWriteGuard<'lock, T, Lock = RwSpinlock>
where
    Lock: RawRwLock,
    T: ?Sized,
{ /* private fields */ }

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

The data protected by the RwLock can be mutably accessed through this guard via its Deref and DerefMut implementations.

This structure is created by the write and try_write methods on RwLock.

Trait Implementations

impl<T, R, Lock> AsRef<R> for RwLockWriteGuard<'_, T, Lock>

where T: AsRef<R> + ?Sized, Lock: RawRwLock, R: ?Sized,

fn as_ref(&self) -> &R

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, Lock> Debug for RwLockWriteGuard<'_, T, Lock>

where T: Debug + ?Sized, Lock: RawRwLock,

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

Formats the value using the given formatter.

impl<T, Lock> Deref for RwLockWriteGuard<'_, T, Lock>

where Lock: RawRwLock, T: ?Sized,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<RwLockWriteGuard<'_, T, Lock> as Deref>::Target

Dereferences the value.

impl<T, Lock> DerefMut for RwLockWriteGuard<'_, T, Lock>

where Lock: RawRwLock, T: ?Sized,

fn deref_mut(&mut self) -> &mut <RwLockWriteGuard<'_, T, Lock> as Deref>::Target

Mutably dereferences the value.

impl<T, Lock> Display for RwLockWriteGuard<'_, T, Lock>

where T: Display + ?Sized, Lock: RawRwLock,

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

Formats the value using the given formatter.

impl<T, Lock> Drop for RwLockWriteGuard<'_, T, Lock>

where Lock: RawRwLock, T: ?Sized,

fn drop(&mut self)

Executes the destructor for this type.

impl<T, Lock> Send for RwLockWriteGuard<'_, T, Lock>

where T: Send + Sync + ?Sized, Lock: RawRwLock, <Lock as RawRwLock>::GuardMarker: Send,

A RwLockWriteGuard is only Send if T is Send and Sync, because it can be used to move a T across thread boundaries, as it allows mutable access to the T that can be used with core::mem::replace or core::mem::swap.

impl<T, Lock> Sync for RwLockWriteGuard<'_, T, Lock>

where T: Send + Sync + ?Sized, Lock: RawRwLock,

A RwLockWriteGuard is only Sync if T is Send and Sync, because it can be used to move a T across thread boundaries, as it allows mutable access to the T that can be used with core::mem::replace or core::mem::swap.