Struct cooptex::CoopMutex

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

A deadlock-free version of Mutex.

This is only deadlock-free if:

1. All Mutexes that may deadlock are CoopMutexes
2. When Retry is returned, the requesting thread drops all other MutexGuards it is holding. Easily accomplished with retry_loop.

Implementations

impl<T> CoopMutex<T>

pub fn new(item: T) -> Self

Create a new CoopMutex holding the provided item.

pub fn lock(&self) -> Result<LockResult<MutexGuard<'_, T>>, Retry>

Acquire a mutex or return Err(Retry), indicating that the current thread should drop all its currently held locks and try to acquire them again. Use retry_loop to automatically use the correct behavior.