Struct Mutex

pub struct Mutex<T>(/* private fields */)
where
    T: ?Sized;

A wrapper around std::sync::Mutex that panics on poison.

This Mutex works similarly to the standard library’s Mutex, except its lock method does not return a Result. Instead, if the mutex is poisoned, it will panic.

Examples

use matrix_sdk_common::locks::Mutex;

let mutex = Mutex::new(42);

{
    let mut guard = mutex.lock();
    *guard = 100;
}

assert_eq!(*mutex.lock(), 100);

Implementations

impl<T> Mutex<T>

pub const fn new(t: T) -> Mutex<T>

Creates a new Mutex wrapping the given value.

impl<T> Mutex<T>

where T: ?Sized,

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

Acquires the lock, panicking if the lock is poisoned.

This method blocks the current thread until the lock is acquired.

Trait Implementations

impl<T> Debug for Mutex<T>

where T: Debug + ?Sized,

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

Formats the value using the given formatter.

impl<T> Default for Mutex<T>

where T: Default + ?Sized,

fn default() -> Mutex<T>

Returns the “default value” for a type.