Struct Mutex 

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

An async mutex: .lock().await yields the calling task (not the OS thread) while the lock is held elsewhere, instead of blocking it.

Errors

None of this type’s methods can fail (no lock poisoning — a panic while holding the guard simply unlocks on unwind, matching tokio::sync::Mutex’s behavior, not std::sync::Mutex’s).

Implementations

impl<T> Mutex<T>

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

Create a new mutex guarding data, initially unlocked.

pub fn into_inner(self) -> T

Consume the mutex, returning the guarded value.

impl<T: ?Sized> Mutex<T>

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

Acquire the lock, waiting (without blocking the OS thread) if it’s currently held elsewhere.

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

Acquire the lock if it’s immediately available, without waiting.

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

Get mutable access to the guarded value without locking — sound because &mut self statically proves no other reference (locked or not) can exist.

Trait Implementations

impl<T: Default> Default for Mutex<T>

fn default() -> Self

Returns the “default value” for a type.

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

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