Struct Mutex 

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

A mutual-exclusion lock whose wait is a future, for the tasks of one shard.

Locking in arrival order: a lock that has to wait is granted the lock by the unlock that frees it, and try_lock fails while anyone waits. It is !Send and !Sync: share it between the tasks of a shard with an Rc.

use nuclei::sync::local::Mutex;

let counter = Mutex::new(0u32);
*counter.try_lock().expect("uncontended") += 1;
assert_eq!(counter.into_inner(), 1);

Implementations

impl<T> Mutex<T>

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

An unlocked mutex holding value.

pub fn into_inner(self) -> T

Consumes the mutex and returns its value.

impl<T: ?Sized> Mutex<T>

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

Waits for the lock, and answers a guard that unlocks when dropped.

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

Locks the mutex if it is free and nobody waits.

Errors

TryLockError when the mutex is locked or owed to a waiter.

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

The value, through a unique borrow: no lock is needed.

Trait Implementations

impl<T: ?Sized + 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() -> Self

Returns the “default value” for a type.

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

fn from(value: T) -> Self

Converts to this type from the input type.