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

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

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

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

Trait Implementations

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

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

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

Formats the value using the given formatter.

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

impl<T> Clone for Lock<T>

fn clone(&self) -> Lock<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn default() -> Lock<T>

Returns the "default value" for a type.

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

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

Performs the conversion.