Documentation

1 files changed, 156 insertions, 0 deletions

diff --git a/src/collection/owned.rs b/src/collection/owned.rs
index d77d568..e1549b2 100644
--- a/src/collection/owned.rs
+++ b/src/collection/owned.rs
@@ -79,16 +79,67 @@ impl<L: OwnedLockable + Default> From<L> for OwnedLockCollection<L> {
 }
 
 impl<L: OwnedLockable> OwnedLockCollection<L> {
+	/// Creates a new collection of owned locks.
+	///
+	/// Because the locks are owned, there's no need to do any checks for
+	/// duplicate values. The locks also don't need to be sorted by memory
+	/// address because they aren't used anywhere else.
+	///
+	/// # Examples
+	///
+	/// ```
+	/// use happylock::Mutex;
+	/// use happylock::collection::OwnedLockCollection;
+	///
+	/// let data = (Mutex::new(0), Mutex::new(""));
+	/// let lock = OwnedLockCollection::new(data);
+	/// ```
 	#[must_use]
 	pub const fn new(data: L) -> Self {
 		Self { data }
 	}
 
+	/// Gets the underlying collection, consuming this collection.
+	///
+	/// # Examples
+	///
+	/// ```
+	/// use happylock::{Mutex, ThreadKey};
+	/// use happylock::collection::OwnedLockCollection;
+	///
+	/// let data = (Mutex::new(42), Mutex::new(""));
+	/// let lock = OwnedLockCollection::new(data);
+	///
+	/// let key = ThreadKey::get().unwrap();
+	/// let inner = lock.into_inner();
+	/// let guard = inner.0.lock(key);
+	/// assert_eq!(*guard, 42);
+	/// ```
 	#[must_use]
 	pub fn into_inner(self) -> L {
 		self.data
 	}
 
+	/// Locks the collection
+	///
+	/// This function returns a guard that can be used to access the underlying
+	/// data. When the guard is dropped, the locks in the collection are also
+	/// dropped.
+	///
+	/// # Examples
+	///
+	/// ```
+	/// use happylock::{Mutex, ThreadKey};
+	/// use happylock::collection::OwnedLockCollection;
+	///
+	/// let key = ThreadKey::get().unwrap();
+	/// let data = (Mutex::new(0), Mutex::new(""));
+	/// let lock = OwnedLockCollection::new(data);
+	///
+	/// let mut guard = lock.lock(key);
+	/// *guard.0 += 1;
+	/// *guard.1 = "1";
+	/// ```
 	pub fn lock<'g, 'key, Key: Keyable + 'key>(
 		&'g self,
 		key: Key,
@@ -109,6 +160,31 @@ impl<L: OwnedLockable> OwnedLockCollection<L> {
 		}
 	}
 
+	/// Attempts to lock the without blocking.
+	///
+	/// If successful, this method returns a guard that can be used to access
+	/// the data, and unlocks the data when it is dropped. Otherwise, `None` is
+	/// returned.
+	///
+	/// # Examples
+	///
+	/// ```
+	/// use happylock::{Mutex, ThreadKey};
+	/// use happylock::collection::OwnedLockCollection;
+	///
+	/// let key = ThreadKey::get().unwrap();
+	/// let data = (Mutex::new(0), Mutex::new(""));
+	/// let lock = OwnedLockCollection::new(data);
+	///
+	/// match lock.try_lock(key) {
+	///     Some(mut guard) => {
+	///         *guard.0 += 1;
+	///         *guard.1 = "1";
+	///     },
+	///     None => unreachable!(),
+	/// };
+	///
+	/// ```
 	pub fn try_lock<'g, 'key: 'g, Key: Keyable + 'key>(
 		&'g self,
 		key: Key,
@@ -139,6 +215,24 @@ impl<L: OwnedLockable> OwnedLockCollection<L> {
 		})
 	}
 
+	/// Unlocks the underlying lockable data type, returning the key that's
+	/// associated with it.
+	///
+	/// # Examples
+	///
+	/// ```
+	/// use happylock::{Mutex, ThreadKey};
+	/// use happylock::collection::OwnedLockCollection;
+	///
+	/// let key = ThreadKey::get().unwrap();
+	/// let data = (Mutex::new(0), Mutex::new(""));
+	/// let lock = OwnedLockCollection::new(data);
+	///
+	/// let mut guard = lock.lock(key);
+	/// *guard.0 += 1;
+	/// *guard.1 = "1";
+	/// let key = OwnedLockCollection::<(Mutex<i32>, Mutex<&str>)>::unlock(guard);
+	/// ```
 	#[allow(clippy::missing_const_for_fn)]
 	pub fn unlock<'g, 'key: 'g, Key: Keyable + 'key>(
 		guard: LockGuard<'key, L::Guard<'g>, Key>,
@@ -149,6 +243,26 @@ impl<L: OwnedLockable> OwnedLockCollection<L> {
 }
 
 impl<L: Sharable> OwnedLockCollection<L> {
+	/// Locks the collection, so that other threads can still read from it
+	///
+	/// This function returns a guard that can be used to access the underlying
+	/// data immutably. When the guard is dropped, the locks in the collection
+	/// are also dropped.
+	///
+	/// # Examples
+	///
+	/// ```
+	/// use happylock::{RwLock, ThreadKey};
+	/// use happylock::collection::OwnedLockCollection;
+	///
+	/// let key = ThreadKey::get().unwrap();
+	/// let data = (RwLock::new(0), RwLock::new(""));
+	/// let lock = OwnedLockCollection::new(data);
+	///
+	/// let mut guard = lock.read(key);
+	/// assert_eq!(*guard.0, 0);
+	/// assert_eq!(*guard.1, "");
+	/// ```
 	pub fn read<'g, 'key, Key: Keyable + 'key>(
 		&'g self,
 		key: Key,
@@ -169,6 +283,32 @@ impl<L: Sharable> OwnedLockCollection<L> {
 		}
 	}
 
+	/// Attempts to lock the without blocking, in such a way that other threads
+	/// can still read from the collection.
+	///
+	/// If successful, this method returns a guard that can be used to access
+	/// the data immutably, and unlocks the data when it is dropped. Otherwise,
+	/// `None` is returned.
+	///
+	/// # Examples
+	///
+	/// ```
+	/// use happylock::{RwLock, ThreadKey};
+	/// use happylock::collection::OwnedLockCollection;
+	///
+	/// let key = ThreadKey::get().unwrap();
+	/// let data = (RwLock::new(5), RwLock::new("6"));
+	/// let lock = OwnedLockCollection::new(data);
+	///
+	/// match lock.try_read(key) {
+	///     Some(mut guard) => {
+	///         assert_eq!(*guard.0, 5);
+	///         assert_eq!(*guard.1, "6");
+	///     },
+	///     None => unreachable!(),
+	/// };
+	///
+	/// ```
 	pub fn try_read<'g, 'key: 'g, Key: Keyable + 'key>(
 		&'g self,
 		key: Key,
@@ -199,6 +339,22 @@ impl<L: Sharable> OwnedLockCollection<L> {
 		})
 	}
 
+	/// Unlocks the underlying lockable data type, returning the key that's
+	/// associated with it.
+	///
+	/// # Examples
+	///
+	/// ```
+	/// use happylock::{RwLock, ThreadKey};
+	/// use happylock::collection::OwnedLockCollection;
+	///
+	/// let key = ThreadKey::get().unwrap();
+	/// let data = (RwLock::new(0), RwLock::new(""));
+	/// let lock = OwnedLockCollection::new(data);
+	///
+	/// let mut guard = lock.read(key);
+	/// let key = OwnedLockCollection::<(RwLock<i32>, RwLock<&str>)>::unlock_read(guard);
+	/// ```
 	#[allow(clippy::missing_const_for_fn)]
 	pub fn unlock_read<'g, 'key: 'g, Key: Keyable + 'key>(
 		guard: LockGuard<'key, L::ReadGuard<'g>, Key>,