[][src]Struct guardian::ArcMutexGuardian

pub struct ArcMutexGuardian<T: 'static> { /* 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]

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> From<Arc<Mutex<T>>> for ArcMutexGuardian<T>
[src]

impl<T> DerefMut for ArcMutexGuardian<T>
[src]

impl<T> Deref for ArcMutexGuardian<T>
[src]

The resulting type after dereferencing.

Auto Trait Implementations

impl<T> !Send for ArcMutexGuardian<T>

impl<T> Sync for ArcMutexGuardian<T> where
    T: Send + Sync

Blanket Implementations

impl<T> From for T
[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]