Struct lock_api::ReentrantMutex

pub struct ReentrantMutex<R, G, T: ?Sized> { /* private fields */ }

A mutex which can be recursively locked by a single thread.

This type is identical to Mutex except for the following points:

• Locking multiple times from the same thread will work correctly instead of deadlocking.
• ReentrantMutexGuard does not give mutable references to the locked data. Use a RefCell if you need this.

See Mutex for more details about the underlying mutex primitive.

Implementations

impl<R: RawMutex, G: GetThreadId, T> ReentrantMutex<R, G, T>

pub fn new(val: T) -> ReentrantMutex<R, G, T>

Creates a new reentrant mutex in an unlocked state ready for use.

pub fn into_inner(self) -> T

Consumes this mutex, returning the underlying data.

impl<R, G, T> ReentrantMutex<R, G, T>

pub const fn const_new(
    raw_mutex: R,
    get_thread_id: G,
    val: T
) -> ReentrantMutex<R, G, T>

Creates a new reentrant mutex based on a pre-existing raw mutex and a helper to get the thread ID.

This allows creating a reentrant mutex in a constant context on stable Rust.

impl<R: RawMutex, G: GetThreadId, T: ?Sized> ReentrantMutex<R, G, T>

pub fn lock(&self) -> ReentrantMutexGuard<'_, R, G, T>

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

If the mutex is held by another thread then this function will block the local thread until it is available to acquire the mutex. If the mutex is already held by the current thread then this function will increment the lock reference count and return immediately. Upon returning, the thread is the only thread with the mutex held. An RAII guard is returned to allow scoped unlock of the lock. When the guard goes out of scope, the mutex will be unlocked.

pub fn try_lock(&self) -> Option<ReentrantMutexGuard<'_, R, G, T>>

Attempts to acquire this lock.

If the lock could not be acquired at this time, then None is returned. Otherwise, an RAII guard is returned. The lock will be unlocked when the guard is dropped.

This function does not block.

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the underlying data.

Since this call borrows the ReentrantMutex mutably, no actual locking needs to take place—the mutable borrow statically guarantees no locks exist.

pub fn is_locked(&self) -> bool

Checks whether the mutex is currently locked.

pub fn is_owned_by_current_thread(&self) -> bool

Checks whether the mutex is currently held by the current thread.

pub unsafe fn force_unlock(&self)

Forcibly unlocks the mutex.

This is useful when combined with mem::forget to hold a lock without the need to maintain a ReentrantMutexGuard object alive, for example when dealing with FFI.

Safety

This method must only be called if the current thread logically owns a ReentrantMutexGuard but that guard has be discarded using mem::forget. Behavior is undefined if a mutex is unlocked when not locked.

pub unsafe fn raw(&self) -> &R

Returns the underlying raw mutex object.

Note that you will most likely need to import the RawMutex trait from lock_api to be able to call functions on the raw mutex.

Safety

This method is unsafe because it allows unlocking a mutex while still holding a reference to a ReentrantMutexGuard.

pub fn data_ptr(&self) -> *mut T

Returns a raw pointer to the underlying data.

This is useful when combined with mem::forget to hold a lock without the need to maintain a ReentrantMutexGuard object alive, for example when dealing with FFI.

Safety

You must ensure that there are no data races when dereferencing the returned pointer, for example if the current thread logically owns a ReentrantMutexGuard but that guard has been discarded using mem::forget.

impl<R: RawMutexFair, G: GetThreadId, T: ?Sized> ReentrantMutex<R, G, T>

pub unsafe fn force_unlock_fair(&self)

Forcibly unlocks the mutex using a fair unlock protocol.

This is useful when combined with mem::forget to hold a lock without the need to maintain a ReentrantMutexGuard object alive, for example when dealing with FFI.

Safety

This method must only be called if the current thread logically owns a ReentrantMutexGuard but that guard has be discarded using mem::forget. Behavior is undefined if a mutex is unlocked when not locked.

impl<R: RawMutexTimed, G: GetThreadId, T: ?Sized> ReentrantMutex<R, G, T>

pub fn try_lock_for(
    &self,
    timeout: R::Duration
) -> Option<ReentrantMutexGuard<'_, R, G, T>>

Attempts to acquire this lock until a timeout is reached.

If the lock could not be acquired before the timeout expired, then None is returned. Otherwise, an RAII guard is returned. The lock will be unlocked when the guard is dropped.

pub fn try_lock_until(
    &self,
    timeout: R::Instant
) -> Option<ReentrantMutexGuard<'_, R, G, T>>

Attempts to acquire this lock until a timeout is reached.

If the lock could not be acquired before the timeout expired, then None is returned. Otherwise, an RAII guard is returned. The lock will be unlocked when the guard is dropped.

Trait Implementations

impl<R: RawMutex, G: GetThreadId, T: ?Sized + Debug> Debug for ReentrantMutex<R, G, T>

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

Formats the value using the given formatter.

impl<R: RawMutex, G: GetThreadId, T: ?Sized + Default> Default for ReentrantMutex<R, G, T>

fn default() -> ReentrantMutex<R, G, T>

Returns the “default value” for a type.

impl<R: RawMutex, G: GetThreadId, T> From<T> for ReentrantMutex<R, G, T>

fn from(t: T) -> ReentrantMutex<R, G, T>

Performs the conversion.

impl<R: RawMutex + Send, G: GetThreadId + Send, T: ?Sized + Send> Send for ReentrantMutex<R, G, T>

impl<R: RawMutex + Sync, G: GetThreadId + Sync, T: ?Sized + Send> Sync for ReentrantMutex<R, G, T>