Struct safina_sync::Mutex

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

A wrapper around std::sync::Mutex with an async lock method.

Implementations

impl<T> Mutex<T>

pub fn new(value: T) -> Mutex<T>

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

Acquires the mutex, sleeping the current task until it is able to do so.

After this function returns, is the only task holding the lock.

The returned guard is an RAII scoped lock. It automatically unlocks the mutex when dropped (falls out of scope).

The returned guard is not Send so you cannot await while holding it.

If a task panics while holding the guard, the underlying mutex becomes “poisoned” and subsequent calls to lock will panic.