Expand description
This library provides implementations of Mutex, RwLock, Condvar,
Barrier, and Once that are smaller and faster than those in the Rust
standard library. It also provides a ReentrantMutex type.
Everything is powered by lock-free thread queues in userspace
which allows the synchronization primitives to be 1 word (usize) large.
All thread blocking is done through std::thread::park for maximum portability.
Re-exports§
pub use ::lock_api;
Structs§
- Barrier
- A barrier enables multiple threads to synchronize the beginning of some computation.
- Barrier
Wait Result - A
BarrierWaitResultis returned byBarrier::wait()when all threads in theBarrierhave rendezvoused. - Condvar
- A Condition Variable
- Once
- A synchronization primitive which can be used to run a one-time initialization. Useful for one-time initialization for globals, FFI or related functionality.
- RawMutex
- Raw mutex type implemented with lock-free userspace thread queues.
- RawRw
Lock - Raw rwlock type implemented with lock-free userspace thread queues.
- RawThread
Id - Implementation of the
GetThreadIdtrait forlock_api::ReentrantMutex. - Wait
Timeout Result - A type indicating whether a timed wait on a condition variable returned due to a time out or not.
Enums§
- Once
State - Current state of a
Once.
Functions§
- const_
mutex - Creates a new mutex in an unlocked state ready for use.
- const_
reentrant_ mutex - Creates a new reentrant mutex in an unlocked state ready for use.
- const_
rwlock - Creates a new instance of an
RwLock<T>which is unlocked.
Type Aliases§
- Mapped
Mutex Guard - An RAII mutex guard returned by
MutexGuard::map, which can point to a subfield of the protected data. - Mapped
Reentrant Mutex Guard - An RAII mutex guard returned by
ReentrantMutexGuard::map, which can point to a subfield of the protected data. - Mapped
RwLock Read Guard - An RAII read lock guard returned by
RwLockReadGuard::map, which can point to a subfield of the protected data. - Mapped
RwLock Write Guard - An RAII write lock guard returned by
RwLockWriteGuard::map, which can point to a subfield of the protected data. - Mutex
- A mutual exclusion primitive useful for protecting shared data
- Mutex
Guard - An RAII implementation of a “scoped lock” of a mutex. When this structure is dropped (falls out of scope), the lock will be unlocked.
- Reentrant
Mutex - A mutex which can be recursively locked by a single thread.
- Reentrant
Mutex Guard - An RAII implementation of a “scoped lock” of a reentrant mutex. When this structure is dropped (falls out of scope), the lock will be unlocked.
- RwLock
- A reader-writer lock
- RwLock
Read Guard - RAII structure used to release the shared read access of a lock when dropped.
- RwLock
Write Guard - RAII structure used to release the exclusive write access of a lock when dropped.