Struct MutexGuard

pub struct MutexGuard<'mutex, 'handle, T>
where
    T: Debug,
{ /* private fields */ }

A guard which allows the modification of a value guarded by a Mutex. It is returned in Mutex::lock(), Mutex::try_lock() and Mutex::timed_lock().

Example

use iceoryx2_bb_posix::mutex::*;

let handle = MutexHandle::<i32>::new();
let mutex = MutexBuilder::new().create(123, &handle)
                               .expect("failed to create mutex");

{
    let mut guard = mutex.lock().expect("failed to lock");
    println!("Old value is {}", *guard);
    *guard = 456;
}

Trait Implementations

impl<'mutex, 'handle, T> Debug for MutexGuard<'mutex, 'handle, T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for MutexGuard<'_, '_, T>

where T: Debug,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<MutexGuard<'_, '_, T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for MutexGuard<'_, '_, T>

where T: Debug,

fn deref_mut(&mut self) -> &mut <MutexGuard<'_, '_, T> as Deref>::Target

Mutably dereferences the value.

impl<T> Drop for MutexGuard<'_, '_, T>

where T: Debug,

fn drop(&mut self)

Executes the destructor for this type.

impl<T> PartialEq for MutexGuard<'_, '_, T>

where T: Debug,

fn eq(&self, other: &MutexGuard<'_, '_, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Eq for MutexGuard<'_, '_, T>

where T: Debug,

impl<T> Send for MutexGuard<'_, '_, T>

where T: Send + Debug,

impl<T> Sync for MutexGuard<'_, '_, T>

where T: Send + Sync + Debug,