Struct Mutex 

pub struct Mutex<T, R>(/* private fields */);

A mutex assuming lock poisoning will never occur.

Implementations

impl<T, R: RawMutex> Mutex<T, R>

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

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

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

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

Panics

This method may panic if the calling thread is already holding the lock.

pub fn into_inner(self) -> T

Consumes this mutex, returning the underlying data.

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 needs to take place.

Trait Implementations

impl<T: Debug, R: RawMutex> Debug for Mutex<T, R>

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

Formats the value using the given formatter.

impl<T: Default, R: RawMutex> Default for Mutex<T, R>

fn default() -> Self

Returns the “default value” for a type.

impl<T: 'static, R: RawMutex + 'static> ExclusiveLock<T> for Mutex<T, R>

type Guard<'l> = MutexGuard<'l, R, T>

The guard type returned when locking the lock.

fn lock(&self) -> Self::Guard<'_>

Locks this lock.

impl<T, I: Ip, R> GenericOverIp<I> for Mutex<T, R>

where T: GenericOverIp<I>,

type Type = Mutex<<T as GenericOverIp<I>>::Type, R>

The type of Self when its IP-generic parameter is replaced with the type NewIp.