Struct async_mutex::Mutex
source · [−]pub struct Mutex<T: ?Sized> { /* private fields */ }
Expand description
An async mutex.
Implementations
sourceimpl<T> Mutex<T>
impl<T> Mutex<T>
sourceimpl<T: ?Sized> Mutex<T>
impl<T: ?Sized> Mutex<T>
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_mutex::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_mutex::Mutex;
let mut mutex = Mutex::new(0);
*mutex.get_mut() = 10;
assert_eq!(*mutex.lock().await, 10);
sourceimpl<T: ?Sized> Mutex<T>
impl<T: ?Sized> Mutex<T>
sourcepub async fn lock_arc(self: &Arc<Self>) -> MutexGuardArc<T>
pub async fn lock_arc(self: &Arc<Self>) -> MutexGuardArc<T>
Acquires the mutex and clones a reference to it.
Returns an owned guard that releases the mutex when dropped.
Examples
use async_mutex::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<Self>) -> Option<MutexGuardArc<T>>
pub fn try_lock_arc(self: &Arc<Self>) -> 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_mutex::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 + ?Sized> Send for Mutex<T>
impl<T: Send + ?Sized> Sync for Mutex<T>
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