Struct Mutex

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

A mutual exclusion primitive useful for protecting shared data. Async version.

This mutex will block a task waiting for the lock to become available.

Implementations

impl<T> Mutex<T>

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

Construct a new Mutex.

impl<T: ?Sized> Mutex<T>

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

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

This is a sync version, and calling it from an async task will possibly block the async work thread, potentially causing deadlock.

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

Aquire the mutex, async version.

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

Attempt to aquire the lock.

Trait Implementations

impl<T> Debug for Mutex<T>

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

Formats the value using the given formatter.

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

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