[−]Struct smol::lock::Mutex
An async mutex.
Implementations
impl<T> Mutex<T>
pub fn new(data: T) -> Mutex<T>
pub fn into_inner(self) -> T
Consumes the mutex, returning the underlying data.
Examples
use async_mutex::Mutex; let mutex = Mutex::new(10); assert_eq!(mutex.into_inner(), 10);
impl<T> Mutex<T> where
T: ?Sized,
T: ?Sized,
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);
pub fn try_lock(&self) -> Option<MutexGuard<'_, T>>
Attempts to acquire the mutex.
If the mutex could not be acquired at this time, then None
is returned. Otherwise, a
guard is returned that releases the mutex when dropped.
Examples
use async_mutex::Mutex; let mutex = Mutex::new(10); if let Some(guard) = mutex.try_lock() { assert_eq!(*guard, 10); }
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);
Trait Implementations
impl<T> Debug for Mutex<T> where
T: Debug + ?Sized,
T: Debug + ?Sized,
impl<T> Default for Mutex<T> where
T: Default + ?Sized,
T: Default + ?Sized,
impl<T> From<T> for Mutex<T>
impl<T> Send for Mutex<T> where
T: Send + ?Sized,
T: Send + ?Sized,
impl<T> Sync for Mutex<T> where
T: Send + ?Sized,
T: Send + ?Sized,
Auto Trait Implementations
impl<T> !RefUnwindSafe for Mutex<T>
impl<T: ?Sized> Unpin for Mutex<T> where
T: Unpin,
T: Unpin,
impl<T: ?Sized> UnwindSafe for Mutex<T> where
T: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut Tⓘ
[src]
impl<T> From<!> for T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,