Struct RecursiveMutex 

pub struct RecursiveMutex { /* private fields */ }

RAII wrapper around a recursive mutex.

Implementations

impl RecursiveMutex

pub fn new() -> Result<Self>

Create a new recursive mutex via heap allocation (only in heap mode).

pub fn create(storage: &'static RecursiveMutexStorage) -> Result<Self>

Mode-agnostic constructor (see Mutex::create).

pub fn lock(&self) -> Result<RecursiveMutexGuard<'_>>

Acquire the recursive mutex, blocking indefinitely. Returns an RAII guard that releases one level of the lock on drop. Same thread may call this multiple times — each guard releases one level when dropped.

pub fn try_lock(&self) -> Result<RecursiveMutexGuard<'_>>

Attempt to acquire the recursive mutex without blocking.

Errors

Returns Error::WouldBlock if held by a different thread.

pub fn try_lock_for(&self, d: Duration) -> Result<RecursiveMutexGuard<'_>>

Attempt to acquire the recursive mutex, waiting up to d.

pub fn try_lock_until( &self, deadline: Instant, ) -> Result<RecursiveMutexGuard<'_>>

Attempt to acquire the recursive mutex by the given deadline. Use Instant::FOREVER for an indefinite wait.

pub fn unlock(&self)

Release one level of the recursive lock.

Prefer letting the RAII guard (RecursiveMutexGuard) drop release the lock; this is kept pub for parity with the C API.

Trait Implementations

impl Debug for RecursiveMutex

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

Formats the value using the given formatter.

impl Drop for RecursiveMutex

fn drop(&mut self)

Executes the destructor for this type.

impl Send for RecursiveMutex

impl Sync for RecursiveMutex