Struct Mutex

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

A mutual exclusion primitive useful for protecting shared data

This mutex will block threads waiting for the lock to become available. The mutex can be created via a [new] constructor. Each mutex has a type parameter which represents the data that it is protecting. The data can only be accessed through the RAII guards returned from [lock] and [try_lock], which guarantees that the data is only ever accessed when the mutex is locked.

Poisoning

Standard library mutexes can become poisoned when the holder panics. However, this crate’s mutexes do not become poisoned as there’s currently no reliable way to detect panics. Poisoning may be added in the future if it becomes possible.

Implementations

impl<T> Mutex<T>

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

Creates a new mutex in an unlocked state ready for use.

impl<T: ?Sized> Mutex<T>

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

Acquires a mutex, blocking the current thread until it is able to do so.

This function will block the local thread until it is available to acquire the mutex. Upon returning, the thread is the only thread with the lock held. An RAII guard is returned to allow scoped unlock of the lock. When the guard goes out of scope, the mutex will be unlocked.

The exact behavior on locking a mutex in the thread which already holds the lock is left unspecified. However, this function will not return on the second call (it might panic or deadlock, for example).

Errors

Currently this function cannot fail. The standard library’s Mutex may fail if there is a panic while the lock is held, but without the standard library we currently have no good way to detect panics. Poisoning may be added at a later time.

Panics

This function might panic when called if the lock is already held by the current thread.

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

Attempts to acquire this lock.

If the lock could not be acquired at this time, then Err is returned. Otherwise, an RAII guard is returned. The lock will be unlocked when the guard is dropped.

This function does not block.

Errors

If the mutex could not be acquired because it is already locked, then this call will return the [WouldBlock] error.

pub fn into_inner(self) -> LockResult<T>

where T: Sized,

Consumes this mutex, returning the underlying data.

Errors

If another user of this mutex panicked while holding the mutex, then this call will return an error instead.

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

Returns a mutable reference to the underlying data.

Since this call borrows the Mutex mutably, no actual locking needs to take place – the mutable borrow statically guarantees no locks exist.

Errors

If another user of this mutex panicked while holding the mutex, then this call will return an error instead.

Trait Implementations

impl<T: Debug + ?Sized> Debug for Mutex<T>

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

Formats the value using the given formatter.

impl<T: Default + ?Sized> Default for Mutex<T>

fn default() -> Mutex<T>

Returns the “default value” for a type.

impl<T: ?Sized + Send> Send for Mutex<T>

impl<T: ?Sized + Send> Sync for Mutex<T>