Module lock

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

BiLockbilock

A type of futures-powered synchronization primitive which is a mutex between two possible owners.

BiLockAcquirebilock

Future returned by BiLock::lock which will resolve when the lock is acquired.

BiLockGuardbilock

Returned RAII guard from the poll_lock method.

MappedMutexGuard

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.

Mutex

A futures-aware mutex.

MutexGuard

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.

MutexLockFuture

A future which resolves when the target mutex has been successfully acquired.

OwnedMutexGuard

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.

OwnedMutexLockFuture

A future which resolves when the target mutex has been successfully acquired, owned version.

ReuniteErrorbilock

Error indicating two BiLock<T>s were not two halves of a whole, and thus could not be reunited.