Struct futures_intrusive::sync::GenericMutex

pub struct GenericMutex<MutexType: RawMutex, T> { /* fields omitted */ }

A futures-aware mutex.

Methods

impl<MutexType: RawMutex, T> GenericMutex<MutexType, T>

pub fn new(value: T, is_fair: bool) -> GenericMutex<MutexType, T>

Creates a new futures-aware mutex.

is_fair defines whether the Mutex should behave be fair regarding the order of waiters. A fair Mutex will only allow the first waiter which tried to lock but failed to lock the Mutex once it's available again. Other waiters must wait until either this locking attempt completes, and the Mutex gets unlocked again, or until the MutexLockFuture which tried to gain the lock is dropped.

Important traits for GenericMutexLockFuture<'a, MutexType, T>

impl<'a, MutexType: RawMutex, T> Future for GenericMutexLockFuture<'a, MutexType, T> type Output = GenericMutexGuard<'a, MutexType, T>;

pub fn lock(&self) -> GenericMutexLockFuture<MutexType, T>

Acquire the mutex asynchronously.

This method returns a future that will resolve once the mutex has been successfully acquired.

pub fn try_lock(&self) -> Option<GenericMutexGuard<MutexType, T>>

Tries to acquire the mutex

If acquiring the mutex is successful, a GenericMutexGuard will be returned, which allows to access the contained data.

Otherwise None will be returned.

pub fn is_locked(&self) -> bool

Returns whether the mutex is locked.

Trait Implementations

impl<T: Send, MutexType: RawMutex + Sync> Sync for GenericMutex<MutexType, T>

impl<T: Send, MutexType: RawMutex + Send> Send for GenericMutex<MutexType, T>

impl<MutexType: RawMutex, T: Debug> Debug for GenericMutex<MutexType, T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.