Struct guardian::ArcRwLockWriteGuardian

pub struct ArcRwLockWriteGuardian<T: 'static> { /* private fields */ }

RAII structure used to release the exclusive write access of a lock when dropped. Keeps a handle to an Arc so that the lock is not dropped until the guard is.

The data protected by the mutex can be access through this guard via its Deref and DerefMut implementations.

Implementations

impl<T> ArcRwLockWriteGuardian<T>

pub fn take(handle: Arc<RwLock<T>>) -> LockResult<ArcRwLockWriteGuardian<T>>

Locks this rwlock with exclusive write access, blocking the current thread until it can be acquired.

This function will not return while other writers or other readers currently have access to the lock.

Returns an RAII guard which will drop the write access of this rwlock when dropped. The guardian also holds a strong reference to the lock’s Arc, which is dropped when the guard is.

Errors

This function will return an error if the RwLock is poisoned. An RwLock is poisoned whenever a writer panics while holding an exclusive lock. An error will be returned when the lock is acquired.

Trait Implementations

impl<T> Deref for ArcRwLockWriteGuardian<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for ArcRwLockWriteGuardian<T>

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

Mutably dereferences the value.

impl<T> From<Arc<RwLock<T>>> for ArcRwLockWriteGuardian<T>

fn from(handle: Arc<RwLock<T>>) -> Self

Converts to this type from the input type.