Struct Mutex

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

A simple mutex.

Implementations

impl<T> Mutex<T>

pub fn new(data: T) -> Mutex<T>

Creates a new mutex.

Examples

use simple_mutex::Mutex;

let mutex = Mutex::new(0);

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

Acquires the mutex.

Returns a guard that releases the mutex when dropped.

Examples

use simple_mutex::Mutex;

let mutex = Mutex::new(10);
let guard = mutex.lock();
assert_eq!(*guard, 10);

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

Attempts to acquire the mutex.

If the mutex could not be acquired at this time, then None is returned. Otherwise, a guard is returned that releases the mutex when dropped.

Examples

use simple_mutex::Mutex;

let mutex = Mutex::new(10);
if let Some(guard) = mutex.try_lock() {
    assert_eq!(*guard, 10);
}

pub fn into_inner(self) -> T

Consumes the mutex, returning the underlying data.

Examples

use simple_mutex::Mutex;

let mutex = Mutex::new(10);
assert_eq!(mutex.into_inner(), 10);

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

Returns a mutable reference to the underlying data.

Since this call borrows the mutex mutably, no actual locking takes place – the mutable borrow statically guarantees the mutex is not already acquired.

Examples

use simple_mutex::Mutex;

let mut mutex = Mutex::new(0);
*mutex.get_mut() = 10;
assert_eq!(*mutex.lock(), 10);

Trait Implementations

impl<T: Debug> Debug for Mutex<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Mutex<T>

fn default() -> Mutex<T>

Returns the “default value” for a type.

impl<T> From<T> for Mutex<T>

fn from(val: T) -> Mutex<T>

Converts to this type from the input type.

impl<T: Send> Send for Mutex<T>

impl<T: Send> Sync for Mutex<T>