Struct guardian::ArcMutexGuardian
[−]
[src]
pub struct ArcMutexGuardian<T: 'static> {
// some fields omitted
}An RAII implementation of a "scoped lock" of a mutex. When this structure is dropped (falls out
of scope), the lock will be unlocked. 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.
Methods
impl<T> ArcMutexGuardian<T>[src]
fn take(handle: Arc<Mutex<T>>) -> LockResult<ArcMutexGuardian<T>>
Acquires a mutex, blocking the current thread until it is able to do so.
This function will block the local thread until it is available to acquire the mutex. Upon
returning, the thread is the only thread with the mutex held. An RAII guardian is returned
to allow scoped unlock of the lock. When the guard goes out of scope, the mutex will be
unlocked. The guardian also holds a strong reference to the lock's Arc, which is dropped
when the guard is.
Errors
If another user of this mutex panicked while holding the mutex, then this call will return an error once the mutex is acquired.
Trait Implementations
impl<T> Deref for ArcMutexGuardian<T>[src]
type Target = T
The resulting type after dereferencing
fn deref(&self) -> &Self::Target
The method called to dereference a value
impl<T> DerefMut for ArcMutexGuardian<T>[src]
fn deref_mut(&mut self) -> &mut T
The method called to mutably dereference a value