Struct tokio_sync::Lock

pub struct Lock<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> Lock<T>

pub fn new(t: T) -> Self

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

pub async fn lock<'_>(&'_ mut self) -> LockGuard<T>

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

Trait Implementations

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

impl<T> From<T> for Lock<T>

fn from(s: T) -> Self

Performs the conversion.

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

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

fn default() -> Self

Returns the "default value" for a type.

impl<T> Clone for Lock<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Lock<T>

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

Formats the value using the given formatter.