Expand description
This library provides type-safe and fully-featured Mutex and RwLock
types which wrap a simple raw mutex or rwlock type. This has several
benefits: not only does it eliminate a large portion of the work in
implementing custom lock types, it also allows users to write code which is
generic with regards to different lock implementations.
Basic usage of this crate is very straightforward:
- Create a raw lock type. This should only contain the lock state, not any data protected by the lock.
- Implement the
RawMutextrait for your custom lock type. - Export your mutex as a type alias for
lock_api::Mutex, and your mutex guard as a type alias forlock_api::MutexGuard. See the example below for details.
This process is similar for RwLocks, except that two guards need to be exported instead of one. (Or 3 guards if your type supports upgradable read locks, see extension traits below for details)
Example
use lock_api::{RawMutex, Mutex, GuardSend};
use std::sync::atomic::{AtomicBool, Ordering};
// 1. Define our raw lock type
pub struct RawSpinlock(AtomicBool);
// 2. Implement RawMutex for this type
unsafe impl RawMutex for RawSpinlock {
const INIT: RawSpinlock = RawSpinlock(AtomicBool::new(false));
// A spinlock guard can be sent to another thread and unlocked there
type GuardMarker = GuardSend;
fn lock(&self) {
// Note: This isn't the best way of implementing a spinlock, but it
// suffices for the sake of this example.
while !self.try_lock() {}
}
fn try_lock(&self) -> bool {
self.0
.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed)
.is_ok()
}
unsafe fn unlock(&self) {
self.0.store(false, Ordering::Release);
}
}
// 3. Export the wrappers. This are the types that your users will actually use.
pub type Spinlock<T> = lock_api::Mutex<RawSpinlock, T>;
pub type SpinlockGuard<'a, T> = lock_api::MutexGuard<'a, RawSpinlock, T>;Extension traits
In addition to basic locking & unlocking functionality, you have the option of exposing additional functionality in your lock types by implementing additional traits for it. Examples of extension features include:
- Fair unlocking (
RawMutexFair,RawRwLockFair) - Lock timeouts (
RawMutexTimed,RawRwLockTimed) - Downgradable write locks (
RawRwLockDowngradable) - Recursive read locks (
RawRwLockRecursive) - Upgradable read locks (
RawRwLockUpgrade)
The Mutex and RwLock wrappers will automatically expose this additional
functionality if the raw lock type implements these extension traits.
Cargo features
This crate supports two cargo features:
owning_ref: Allows your lock types to be used with theowning_refcrate.nightly: Enables nightly-only features. At the moment the only such feature isconst fnconstructors for lock types.
Structs
Marker type which indicates that the Guard type for a lock is not Send.
Marker type which indicates that the Guard type for a lock is Send.
An RAII mutex guard returned by MutexGuard::map, which can point to a
subfield of the protected data.
An RAII mutex guard returned by ReentrantMutexGuard::map, which can point to a
subfield of the protected data.
An RAII read lock guard returned by RwLockReadGuard::map, which can point to a
subfield of the protected data.
An RAII write lock guard returned by RwLockWriteGuard::map, which can point to a
subfield of the protected data.
A mutual exclusion primitive useful for protecting shared data
An RAII implementation of a “scoped lock” of a mutex. When this structure is dropped (falls out of scope), the lock will be unlocked.
A raw mutex type that wraps another raw mutex to provide reentrancy.
A mutex which can be recursively locked by a single thread.
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.
A reader-writer lock
RAII structure used to release the shared read access of a lock when dropped.
RAII structure used to release the upgradable read access of a lock when dropped.
RAII structure used to release the exclusive write access of a lock when dropped.
Traits
Helper trait which returns a non-zero thread ID.
Basic operations for a mutex.
Additional methods for mutexes which support fair unlocking.
Additional methods for mutexes which support locking with timeouts.
Basic operations for a reader-writer lock.
Additional methods for RwLocks which support atomically downgrading an exclusive lock to a shared lock.
Additional methods for RwLocks which support fair unlocking.
Additional methods for RwLocks which support recursive read locks.
Additional methods for RwLocks which support recursive read locks and timeouts.
Additional methods for RwLocks which support locking with timeouts.
Additional methods for RwLocks which support atomically upgrading a shared lock to an exclusive lock.
Additional methods for RwLocks which support upgradable locks and lock downgrading.
Additional methods for RwLocks which support upgradable locks and fair unlocking.
Additional methods for RwLocks which support upgradable locks and locking with timeouts.