Struct qt_core::QRecursiveMutex

#[repr(C)]
pub struct QRecursiveMutex { /* private fields */ }

The QRecursiveMutex class is a mutex, like QMutex, with which it is API-compatible. It differs from QMutex by accepting lock() calls from the same thread any number of times. QMutex would deadlock in this situation.

C++ class: QRecursiveMutex.

C++ documentation:

The QRecursiveMutex class is a mutex, like QMutex, with which it is API-compatible. It differs from QMutex by accepting lock() calls from the same thread any number of times. QMutex would deadlock in this situation.

QRecursiveMutex is much more expensive to construct and operate on, so use a plain QMutex whenever you can. Sometimes, one public function, however, calls another public function, and they both need to lock the same mutex. In this case, you have two options:

• Factor the code that needs mutex protection into private functions, which assume that the mutex is held when they are called, and lock a plain QMutex in the public functions before you call the private implementation ones.
• Or use a recursive mutex, so it doesn't matter that the first public function has already locked the mutex when the second one wishes to do so.

Implementations

impl QRecursiveMutex

pub unsafe fn new() -> CppBox<QRecursiveMutex>

Available on cpp_lib_version="5.14.0" only.

Constructs a new recursive mutex. The mutex is created in an unlocked state.

Calls C++ function: [constructor] void QRecursiveMutex::QRecursiveMutex().

C++ documentation:

Constructs a new recursive mutex. The mutex is created in an unlocked state.

See also lock() and unlock().

Trait Implementations

impl CppDeletable for QRecursiveMutex

Available on cpp_lib_version="5.14.0" only.

unsafe fn delete(&self)

Destroys the mutex.

Calls C++ function: [destructor] void QRecursiveMutex::~QRecursiveMutex().

C++ documentation:

Destroys the mutex.

Warning: Destroying a locked mutex may result in undefined behavior.