Struct tokio::sync::Mutex

pub struct Mutex<T> { /* fields omitted */ }

This is supported on feature="sync" only.

An asynchronous mutual exclusion primitive useful for protecting shared data

Each mutex has a type parameter (T) which represents the data that it is protecting. The data can only be accessed through the RAII guards returned from lock, which guarantees that the data is only ever accessed when the mutex is locked.

Methods

impl<T> Mutex<T>

pub fn new(t: T) -> Self

This is supported on feature="sync" only.

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

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

This is supported on feature="sync" only.

A future that resolves on acquiring the lock and returns the MutexGuard.

pub fn try_lock(&self) -> Result<MutexGuard<T>, TryLockError>

This is supported on feature="sync" only.

Try to acquire the lock

Trait Implementations

impl<T: Debug> Debug for Mutex<T>

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(s: T) -> Self

Performs the conversion.

impl<T> Send for Mutex<T> where
    T: Send, 

impl<T> Sync for Mutex<T> where
    T: Send,