Struct tokio::sync::Mutex

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

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) -> Mutex<T>

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

pub fn lock(&'_ self) -> impl Future<Output = MutexGuard<'_, T>>

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

Trait Implementations

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

fn default() -> Mutex<T>

Returns the "default value" for a type.

impl<T> From<T> for Mutex<T>

fn from(s: T) -> Mutex<T>

Performs the conversion.

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

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

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

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

Formats the value using the given formatter.