pub struct Mutex<T> where
T: ?Sized, { /* private fields */ }
Expand description
An async mutex.
The locking mechanism uses eventual fairness to ensure locking will be fair on average without sacrificing performance. This is done by forcing a fair lock whenever a lock operation is starved for longer than 0.5 milliseconds.
Examples
use async_lock::Mutex;
let m = Mutex::new(1);
let mut guard = m.lock().await;
*guard = 2;
assert!(m.try_lock().is_none());
drop(guard);
assert_eq!(*m.try_lock().unwrap(), 2);
Implementations
sourceimpl<T> Mutex<T>
impl<T> Mutex<T>
sourceimpl<T> Mutex<T> where
T: ?Sized,
impl<T> Mutex<T> where
T: ?Sized,
sourcepub async fn lock(&'_ self) -> MutexGuard<'_, T>
pub async fn lock(&'_ self) -> MutexGuard<'_, T>
Acquires the mutex.
Returns a guard that releases the mutex when dropped.
Examples
use async_lock::Mutex;
let mutex = Mutex::new(10);
let guard = mutex.lock().await;
assert_eq!(*guard, 10);
sourcepub fn try_lock(&self) -> Option<MutexGuard<'_, T>>
pub fn try_lock(&self) -> Option<MutexGuard<'_, T>>
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 takes place – the mutable borrow statically guarantees the mutex is not already acquired.
Examples
use async_lock::Mutex;
let mut mutex = Mutex::new(0);
*mutex.get_mut() = 10;
assert_eq!(*mutex.lock().await, 10);
sourceimpl<T> Mutex<T> where
T: ?Sized,
impl<T> Mutex<T> where
T: ?Sized,
sourcepub fn lock_arc(self: &Arc<Mutex<T>>) -> impl Future<Output = MutexGuardArc<T>>
pub fn lock_arc(self: &Arc<Mutex<T>>) -> impl Future<Output = MutexGuardArc<T>>
Acquires the mutex and clones a reference to it.
Returns an owned guard that releases the mutex when dropped.
Examples
use async_lock::Mutex;
use std::sync::Arc;
let mutex = Arc::new(Mutex::new(10));
let guard = mutex.lock_arc().await;
assert_eq!(*guard, 10);
sourcepub fn try_lock_arc(self: &Arc<Mutex<T>>) -> Option<MutexGuardArc<T>>
pub fn try_lock_arc(self: &Arc<Mutex<T>>) -> Option<MutexGuardArc<T>>
Attempts to acquire the mutex and clone a reference to it.
If the mutex could not be acquired at this time, then None
is returned. Otherwise, an
owned guard is returned that releases the mutex when dropped.
Examples
use async_lock::Mutex;
use std::sync::Arc;
let mutex = Arc::new(Mutex::new(10));
if let Some(guard) = mutex.try_lock() {
assert_eq!(*guard, 10);
}
Trait Implementations
impl<T> Send for Mutex<T> where
T: Send + ?Sized,
impl<T> Sync for Mutex<T> where
T: Send + ?Sized,
Auto Trait Implementations
impl<T> !RefUnwindSafe for Mutex<T>
impl<T: ?Sized> Unpin for Mutex<T> where
T: Unpin,
impl<T: ?Sized> UnwindSafe for Mutex<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more