refactor: move guard type exports into separate module

Author: mkroening

src/lib.rs

@@ -32,6 +32,11 @@
 /// The spinlock implemenation is based on the abstractions provided by the `lock_api` crate.
 pub use lock_api;
 
-pub use spinlock::{MappedSpinlockGuard, RawSpinlock, Spinlock, SpinlockGuard};
+pub use spinlock::{RawSpinlock, Spinlock};
+
+/// Type aliases for guards.
+pub mod guard {
+    pub use super::spinlock::{MappedSpinlockGuard, SpinlockGuard};
+}
 
 mod spinlock;

src/spinlock.rs

@@ -146,7 +146,7 @@ pub type Spinlock<T> = lock_api::Mutex<RawSpinlock, T>;
 /// ## Example
 ///
 /// ```rust
-/// use spinning_top::{Spinlock, SpinlockGuard};
+/// use spinning_top::{guard::SpinlockGuard, Spinlock};
 ///
 /// let spinlock = Spinlock::new(Vec::new());
 ///
@@ -170,7 +170,10 @@ pub type SpinlockGuard<'a, T> = lock_api::MutexGuard<'a, RawSpinlock, T>;
 ///
 /// ## Example
 /// ```rust
-/// use spinning_top::{MappedSpinlockGuard, Spinlock, SpinlockGuard};
+/// use spinning_top::{
+///     guard::{MappedSpinlockGuard, SpinlockGuard},
+///     Spinlock,
+/// };
 ///
 /// let spinlock = Spinlock::new(Some(3));
 ///