Struct futures::lock::Mutex

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

A futures-aware mutex.

Methods

impl<T> Mutex<T>

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

Creates a new futures-aware mutex.

pub fn into_inner(self) -> T

Consumes this mutex, returning the underlying data.

Examples

use futures::lock::Mutex;

let mutex = Mutex::new(0);
assert_eq!(mutex.into_inner(), 0);

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.

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the underlying data.

Since this call borrows the Mutex mutably, no actual locking needs to take place -- the mutable borrow statically guarantees no locks exist.

Examples

use futures::lock::Mutex;

let mut mutex = Mutex::new(0);
*mutex.get_mut() = 10;
assert_eq!(*mutex.lock().await, 10);

Trait Implementations

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

fn default() -> Mutex<T>

Returns the "default value" for a type.

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

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

Formats the value using the given formatter.

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

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

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

Performs the conversion.

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