From f81d4b40a007fecf6502a36b4c24a1e31807a731 Mon Sep 17 00:00:00 2001
From: Botahamec <botahamec@outlook.com>
Date: Thu, 23 May 2024 19:50:32 -0400
Subject: Comments

---
 src/mutex/guard.rs | 10 ++++++++++
 src/mutex/mutex.rs |  4 ++++
 2 files changed, 14 insertions(+)

(limited to 'src/mutex')

diff --git a/src/mutex/guard.rs b/src/mutex/guard.rs
index 9e8e2e6..f9324ad 100644
--- a/src/mutex/guard.rs
+++ b/src/mutex/guard.rs
@@ -8,6 +8,9 @@ use crate::key::Keyable;
 
 use super::{Mutex, MutexGuard, MutexRef};
 
+// This makes things slightly easier because now you can use
+// `println!("{guard}")` instead of `println!("{}", *guard)`. I wonder if I
+// should implement some other standard library traits like this too?
 impl<'a, T: Debug + ?Sized + 'a, R: RawMutex> Debug for MutexRef<'a, T, R> {
 	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 		Debug::fmt(&**self, f)
@@ -63,11 +66,18 @@ impl<'a, T: ?Sized + 'a, R: RawMutex> AsMut<T> for MutexRef<'a, T, R> {
 impl<'a, T: ?Sized + 'a, R: RawMutex> MutexRef<'a, T, R> {
 	/// Creates a reference to the underlying data of a mutex without
 	/// attempting to lock it or take ownership of the key.
+
+	// This might be useful to export, because it makes it easier to express
+	// the concept of: "Get the data out the mutex but don't lock it or take
+	// the key". But it's also quite dangerous to drop.
 	pub(crate) unsafe fn new(mutex: &'a Mutex<T, R>) -> Self {
 		Self(mutex, PhantomData)
 	}
 }
 
+// it's kinda annoying to re-implement some of this stuff on guards
+// there's nothing i can do about that
+
 impl<'a, 'key, T: Debug + ?Sized + 'a, Key: Keyable + 'key, R: RawMutex> Debug
 	for MutexGuard<'a, 'key, T, Key, R>
 {
diff --git a/src/mutex/mutex.rs b/src/mutex/mutex.rs
index 52b6081..89dfef9 100644
--- a/src/mutex/mutex.rs
+++ b/src/mutex/mutex.rs
@@ -48,6 +48,7 @@ impl<T: ?Sized + Debug, R: RawMutex> Debug for Mutex<T, R> {
 		// safety: this is just a try lock, and the value is dropped
 		//         immediately after, so there's no risk of blocking ourselves
 		//         or any other threads
+		// when i implement try_clone this code will become less unsafe
 		if let Some(value) = unsafe { self.try_lock_no_key() } {
 			f.debug_struct("Mutex").field("data", &&*value).finish()
 		} else {
@@ -77,6 +78,9 @@ impl<T, R: RawMutex> From<T> for Mutex<T, R> {
 	}
 }
 
+// We don't need a `get_mut` because we don't have mutex poisoning. Hurray!
+// This is safe because you can't have a mutable reference to the lock if it's
+// locked. Being locked requires an immutable reference because of the guard.
 impl<T: ?Sized, R> AsMut<T> for Mutex<T, R> {
 	fn as_mut(&mut self) -> &mut T {
 		self.get_mut()
-- 
cgit v1.2.3