Struct ruspiro_lock::async::AsyncMutex

pub struct AsyncMutex<T> { /* fields omitted */ }

An async mutex lock that can be used in async functions to prevent blocking current execution while waiting for the lock to become available. So for this to work the lock() method does not return a MutexGuard immediately but a Future that will resove into a AsyncMutexGuard when awaited.

Implementations

impl<T> AsyncMutex<T>

pub fn new(value: T) -> Self

Create the AsyncMutex

pub async fn lock(&self) -> AsyncMutexGuard<'_, T>

Locking the data secured by the AsyncMutex will yield a Future that must be awaited to actually acquire the lock.

pub fn into_inner(self) -> Result<T, Self>

Provide the inner data wrapped by this AsyncMutex. This will only provide the contained data if there is only one active reference to it. If the data is still shared more than once, eg. because there are active Futures awaiting a lock this will return the actual AsyncMutex in the Err variant.