Struct remutex::ReentrantMutex

pub struct ReentrantMutex<T> { /* fields omitted */ }

A re-entrant mutual exclusion

This mutex will block other threads waiting for the lock to become available. The thread which has already locked the mutex can lock it multiple times without blocking, preventing a common source of deadlocks.

Methods

impl<T> ReentrantMutex<T>

fn new(t: T) -> ReentrantMutex<T>

Creates a new reentrant mutex in an unlocked state.

fn lock(
    &self
) -> Result<ReentrantMutexGuard<T>, PoisonError<ReentrantMutexGuard<T>>>

Acquires a mutex, blocking the current thread until it is able to do so.

This function will block the caller until it is available to acquire the mutex. Upon returning, the thread is the only thread with the mutex held. When the thread calling this method already holds the lock, the call shall succeed without blocking.

Failure

If another user of this mutex panicked while holding the mutex, then this call will return failure if the mutex would otherwise be acquired.

fn try_lock(
    &self
) -> Result<ReentrantMutexGuard<T>, TryLockError<ReentrantMutexGuard<T>>>

Attempts to acquire this lock.

If the lock could not be acquired at this time, then Err is returned. Otherwise, an RAII guard is returned.

This function does not block.

Failure

If another user of this mutex panicked while holding the mutex, then this call will return failure if the mutex would otherwise be acquired.

Trait Implementations

impl<T: Send> Send for ReentrantMutex<T>

impl<T: Send> Sync for ReentrantMutex<T>

impl<T> Drop for ReentrantMutex<T>

fn drop(&mut self)

A method called when the value goes out of scope.

impl<T: Debug + 'static> Debug for ReentrantMutex<T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.