Struct Mutex

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

The basic mutex type. Mutexes are used to share variables between tasks safely.

Implementations

impl<T> Mutex<T>

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

Creates a new mutex.

impl<T: ?Sized> Mutex<T>

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

Locks the mutex so that it cannot be locked in another task at the same time. Blocks the current task until the lock is acquired.

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

Attempts to acquire this lock. This function does not block.

pub fn into_inner(self) -> T

where T: Sized,

Consumes the mutex and returns the inner data.

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

Gets a mutable reference to the inner data.

Trait Implementations

impl<T> Debug for Mutex<T>

where T: ?Sized + Debug,

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

Formats the value using the given formatter.

impl<T> Default for Mutex<T>

where T: Default,

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.

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

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