Struct Mutex 

pub struct Mutex<T: ?Sized> { /* private fields */ }

A std::sync::Mutex that, with rt-paranoid on, flags a lock taken on the audio thread inside a process section. A plugin that wants lock checking uses this in place of the std type; with the feature off it is a zero-cost newtype that just delegates.

It catches only locks taken through this type - not std::sync::Mutex, parking_lot, or an OS primitive reached directly.

Implementations

impl<T> Mutex<T>

pub const fn new(value: T) -> Self

Create a new mutex holding value.

pub fn into_inner(self) -> LockResult<T>

Consume the mutex, returning the inner value.

Errors

Returns the poison error if a holder panicked while holding the lock.

impl<T: ?Sized> Mutex<T>

pub fn lock(&self) -> LockResult<MutexGuard<'_, T>>

Acquire the mutex, blocking the current thread until it can. Flags a real-time violation if taken inside a process section.

Errors

Returns the poison error if a holder panicked while holding the lock.

pub fn try_lock(&self) -> TryLockResult<MutexGuard<'_, T>>

Attempt to acquire the mutex without blocking. Flags a real-time violation if attempted inside a process section.

Errors

Returns WouldBlock if held elsewhere, or the poison error.

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

Borrow the inner value mutably; no lock is taken (unique access).

Errors

Returns the poison error if a holder panicked while holding the lock.