Module futures_util::lock
source · Expand description
Futures-powered synchronization primitives.
This module is only available when the std or alloc feature of this
library is activated, and it is activated by default.
Structs
BiLock
bilockA type of futures-powered synchronization primitive which is a mutex between
two possible owners.
BiLockAcquire
bilockFuture returned by
BiLock::lock which will resolve when the lock is
acquired.BiLockGuard
bilockReturned RAII guard from the
poll_lock method.An RAII guard returned by the
MutexGuard::map and MappedMutexGuard::map methods.
When this structure is dropped (falls out of scope), the lock will be unlocked.A futures-aware mutex.
An RAII guard returned by the
lock and try_lock methods.
When this structure is dropped (falls out of scope), the lock will be
unlocked.A future which resolves when the target mutex has been successfully acquired.
An RAII guard returned by the
lock_owned and try_lock_owned methods.
When this structure is dropped (falls out of scope), the lock will be
unlocked.A future which resolves when the target mutex has been successfully acquired, owned version.
ReuniteError
bilockError indicating two
BiLock<T>s were not two halves of a whole, and
thus could not be reunited.