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
sourceimpl<T> Mutex<T>
impl<T> Mutex<T>
sourcepub fn into_inner(self) -> T
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);sourceimpl<T: ?Sized> Mutex<T>
impl<T: ?Sized> Mutex<T>
sourcepub fn try_lock(&self) -> Option<MutexGuard<'_, 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.
sourcepub fn try_lock_owned(self: &Arc<Self>) -> Option<OwnedMutexGuard<T>>
pub fn try_lock_owned(self: &Arc<Self>) -> Option<OwnedMutexGuard<T>>
Attempt to acquire the lock immediately.
If the lock is currently held, this will return None.
sourcepub fn lock(&self) -> MutexLockFuture<'_, T>ⓘNotable traits for MutexLockFuture<'a, T>impl<'a, T: ?Sized> Future for MutexLockFuture<'a, T> type Output = MutexGuard<'a, T>;
pub fn lock(&self) -> MutexLockFuture<'_, T>ⓘNotable traits for MutexLockFuture<'a, T>impl<'a, T: ?Sized> Future for MutexLockFuture<'a, T> type Output = MutexGuard<'a, T>;
Acquire the lock asynchronously.
This method returns a future that will resolve once the lock has been successfully acquired.
sourcepub fn lock_owned(self: Arc<Self>) -> OwnedMutexLockFuture<T>ⓘNotable traits for OwnedMutexLockFuture<T>impl<T: ?Sized> Future for OwnedMutexLockFuture<T> type Output = OwnedMutexGuard<T>;
pub fn lock_owned(self: Arc<Self>) -> OwnedMutexLockFuture<T>ⓘNotable traits for OwnedMutexLockFuture<T>impl<T: ?Sized> Future for OwnedMutexLockFuture<T> type Output = OwnedMutexGuard<T>;
Acquire the lock asynchronously.
This method returns a future that will resolve once the lock has been successfully acquired.
sourcepub fn get_mut(&mut self) -> &mut T
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);