Merge branch '0.2'

2 files changed, 100 insertions, 13 deletions

diff --git a/src/mutex/guard.rs b/src/mutex/guard.rs
index c7f25e4..f9324ad 100644
--- a/src/mutex/guard.rs
+++ b/src/mutex/guard.rs
@@ -1,3 +1,4 @@
+use std::fmt::{Debug, Display};
 use std::marker::PhantomData;
 use std::ops::{Deref, DerefMut};
 
@@ -7,6 +8,21 @@ 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)
+	}
+}
+
+impl<'a, T: Display + ?Sized + 'a, R: RawMutex> Display for MutexRef<'a, T, R> {
+	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+		Display::fmt(&**self, f)
+	}
+}
+
 impl<'a, T: ?Sized + 'a, R: RawMutex> Drop for MutexRef<'a, T, R> {
 	fn drop(&mut self) {
 		// safety: this guard is being destroyed, so the data cannot be
@@ -35,6 +51,49 @@ impl<'a, T: ?Sized + 'a, R: RawMutex> DerefMut for MutexRef<'a, T, R> {
 	}
 }
 
+impl<'a, T: ?Sized + 'a, R: RawMutex> AsRef<T> for MutexRef<'a, T, R> {
+	fn as_ref(&self) -> &T {
+		self
+	}
+}
+
+impl<'a, T: ?Sized + 'a, R: RawMutex> AsMut<T> for MutexRef<'a, T, R> {
+	fn as_mut(&mut self) -> &mut T {
+		self
+	}
+}
+
+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>
+{
+	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+		Debug::fmt(&**self, f)
+	}
+}
+
+impl<'a, 'key, T: Display + ?Sized + 'a, Key: Keyable + 'key, R: RawMutex> Display
+	for MutexGuard<'a, 'key, T, Key, R>
+{
+	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+		Display::fmt(&**self, f)
+	}
+}
+
 impl<'a, 'key: 'a, T: ?Sized + 'a, Key: Keyable, R: RawMutex> Deref
 	for MutexGuard<'a, 'key, T, Key, R>
 {
@@ -53,6 +112,22 @@ impl<'a, 'key: 'a, T: ?Sized + 'a, Key: Keyable, R: RawMutex> DerefMut
 	}
 }
 
+impl<'a, 'key: 'a, T: ?Sized + 'a, Key: Keyable, R: RawMutex> AsRef<T>
+	for MutexGuard<'a, 'key, T, Key, R>
+{
+	fn as_ref(&self) -> &T {
+		self
+	}
+}
+
+impl<'a, 'key: 'a, T: ?Sized + 'a, Key: Keyable, R: RawMutex> AsMut<T>
+	for MutexGuard<'a, 'key, T, Key, R>
+{
+	fn as_mut(&mut self) -> &mut T {
+		self
+	}
+}
+
 impl<'a, 'key: 'a, T: ?Sized + 'a, Key: Keyable, R: RawMutex> MutexGuard<'a, 'key, T, Key, R> {
 	/// Create a guard to the given mutex. Undefined if multiple guards to the
 	/// same mutex exist at once.
diff --git a/src/mutex/mutex.rs b/src/mutex/mutex.rs
index 917ab78..89dfef9 100644
--- a/src/mutex/mutex.rs
+++ b/src/mutex/mutex.rs
@@ -24,11 +24,22 @@ impl<T, R: RawMutex> Mutex<T, R> {
 			data: UnsafeCell::new(data),
 		}
 	}
-}
 
-impl<T: ?Sized + Default, R: RawMutex> Default for Mutex<T, R> {
-	fn default() -> Self {
-		Self::new(T::default())
+	/// Returns the raw underlying mutex.
+	///
+	/// Note that you will most likely need to import the [`RawMutex`] trait
+	/// from `lock_api` to be able to call functions on the raw mutex.
+	///
+	/// # Safety
+	///
+	/// This method is unsafe because it allows unlocking a mutex while still
+	/// holding a reference to a [`MutexGuard`], and locking a mutex without
+	/// holding the [`ThreadKey`].
+	///
+	/// [`ThreadKey`]: `crate::ThreadKey`
+	#[must_use]
+	pub const unsafe fn raw(&self) -> &R {
+		&self.raw
 	}
 }
 
@@ -37,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 {
@@ -54,12 +66,21 @@ impl<T: ?Sized + Debug, R: RawMutex> Debug for Mutex<T, R> {
 	}
 }
 
+impl<T: ?Sized + Default, R: RawMutex> Default for Mutex<T, R> {
+	fn default() -> Self {
+		Self::new(T::default())
+	}
+}
+
 impl<T, R: RawMutex> From<T> for Mutex<T, R> {
 	fn from(value: T) -> Self {
 		Self::new(value)
 	}
 }
 
+// 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()
@@ -138,15 +159,6 @@ impl<T: ?Sized, R: RawMutex> Mutex<T, R> {
 		}
 	}
 
-	/// Lock without a [`ThreadKey`]. You must exclusively own the
-	/// [`ThreadKey`] as long as the [`MutexRef`] is alive. This may cause
-	/// deadlock if called multiple times without unlocking first.
-	pub(crate) unsafe fn lock_no_key(&self) -> MutexRef<'_, T, R> {
-		self.raw.lock();
-
-		MutexRef(self, PhantomData)
-	}
-
 	/// Attempts to lock the `Mutex` without blocking.
 	///
 	/// # Errors