Struct tokio_sync::lock::Lock

[+] Show declaration

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

[−] Expand description

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 poll_lock, which guarantees that the data is only ever accessed when the mutex is locked.

Implementations

impl<T> Lock<T>[−]

pub fn new(t: T) -> Self[−]

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

pub fn poll_lock(&mut self) -> Async<LockGuard<T>>[−]

Try to acquire the lock.

If the lock is already held, the current task is notified when it is released.

Trait Implementations

impl<T> Clone for Lock<T>[+]

[+] Show hidden undocumented items

fn clone(&self) -> Self[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<T: Debug> Debug for Lock<T>[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result[−]

Formats the value using the given formatter.

impl<T> Default for Lock<T> where
    T: Default, [+]

[+] Show hidden undocumented items

fn default() -> Self[−]

Returns the “default value” for a type.

impl<T> From<T> for Lock<T>[+]

[+] Show hidden undocumented items

fn from(s: T) -> Self[−]

Performs the conversion.

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

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