summaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs11
1 files changed, 8 insertions, 3 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 668f3db..673d279 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -107,19 +107,24 @@
//! ```
mod key;
-mod lockable;
pub mod collection;
+pub mod lockable;
pub mod mutex;
pub mod rwlock;
-pub use collection::BoxedLockCollection as LockCollection;
pub use key::{Keyable, ThreadKey};
-pub use lockable::{Lockable, OwnedLockable, Sharable};
#[cfg(feature = "spin")]
pub use mutex::SpinLock;
+/// A collection of locks that can be acquired simultaneously.
+///
+/// This re-exports [`BoxedLockCollection`] as a sensible default.
+///
+/// [`BoxedLockCollection`]: collection::BoxedLockCollection
+pub type LockCollection<L> = collection::BoxedLockCollection<L>;
+
/// A mutual exclusion primitive useful for protecting shared data, which cannot deadlock.
///
/// By default, this uses `parking_lot` as a backend.