From 0c519b6c7801aa6a085551c8e144f0336e615870 Mon Sep 17 00:00:00 2001 From: Mica White Date: Sun, 10 Mar 2024 18:13:20 -0400 Subject: Better librarification --- src/lib.rs | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'src/lib.rs') diff --git a/src/lib.rs b/src/lib.rs index 25b6d03..e99db7c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -5,17 +5,22 @@ #![allow(clippy::semicolon_if_nothing_returned)] mod collection; -mod key; mod lockable; +pub mod key; pub mod mutex; pub mod rwlock; pub use collection::LockCollection; -pub use key::{Key, ThreadKey}; pub use lockable::Lockable; pub use mutex::SpinLock; +/// The key for the current thread. +/// +/// Only one of these exist per thread. To get the current thread's key, call +/// [`ThreadKey::lock`]. If the `ThreadKey` is dropped, it can be reobtained. +pub type ThreadKey = key::Key<'static>; + /// A mutual exclusion primitive useful for protecting shared data, which cannot deadlock. /// /// By default, this uses `parking_lot` as a backend. -- cgit v1.2.3