Struct futures::lock::Mutex

[+] Show declaration

pub struct Mutex<T> where
    T: ?Sized,  { /* fields omitted */ }

[−] Expand description

A futures-aware mutex.

Methods

impl<T> Mutex<T>[−]

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

Creates a new futures-aware mutex.

impl<T> Mutex<T> where
    T: ?Sized, [−]

pub fn try_lock(&self) -> Option<MutexGuard<T>>[−]

Attempt to acquire the lock immediately.

If the lock is currently held, this will return None.

Important traits for MutexLockFuture<'a, T>

impl<'a, T> Future for MutexLockFuture<'a, T> where
    T: ?Sized,  type Output = MutexGuard<'a, T>;

pub fn lock(&self) -> MutexLockFuture<T>[−]

Acquire the lock asynchronously.

This method returns a future that will resolve once the lock has been successfully acquired.

Trait Implementations

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

[+] Show hidden undocumented items

fn default() -> Mutex<T>[−]

Returns the "default value" for a type.

impl<T> Debug for Mutex<T> where
    T: ?Sized, [+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<T> Sync for Mutex<T> where
    T: Send + ?Sized, 

impl<T> Send for Mutex<T> where
    T: Send + ?Sized,