Struct futures_util::lock::Mutex

source ·
pub struct Mutex<T: ?Sized> { /* private fields */ }
Expand description

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§

Creates a new futures-aware mutex.

Consumes this mutex, returning the underlying data.

Examples
use futures::lock::Mutex;

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

Attempt to acquire the lock immediately.

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

Attempt to acquire the lock immediately.

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

Acquire the lock asynchronously.

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

Acquire the lock asynchronously.

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

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§

Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Converts to this type from the input type.

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.