Struct futures_util::lock::Mutex

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

A futures-aware mutex.

Fairness

This mutex provides no fairness guarantees. Tasks may not acquire the mutex in the order that they requested the lock, and it's possible for a single task which repeatedly takes the lock to starve other tasks, which may be left waiting indefinitely.

Implementations

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: ?Sized> Mutex<T>

pub fn try_lock(&self) -> Option<MutexGuard<'_, T>>

Attempt to acquire the lock immediately.

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

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.

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: ?Sized> Debug for Mutex<T>

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

Formats the value using the given formatter.

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

fn default() -> Mutex<T>

Returns the "default value" for a type.

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

fn from(t: T) -> Self

Performs the conversion.

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

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