Implement const_spinlock convenience function

src/lib.rs

@@ -20,7 +20,7 @@
 //!     // because the spinlock ensures mutual exclusion
 //!     locked_data.make_ascii_uppercase();
 //!     assert_eq!(locked_data.as_str(), "HELLO");
-//!     
+//!
 //!     // the guard automatically frees the lock at the end of the scope
 //! }
 //! ```
@@ -32,6 +32,6 @@
 /// The spinlock implemenation is based on the abstractions provided by the `lock_api` crate.
 pub use lock_api;
 
-pub use spinlock::{RawSpinlock, Spinlock, SpinlockGuard};
+pub use spinlock::{const_spinlock, RawSpinlock, Spinlock, SpinlockGuard};
 
 mod spinlock;

src/spinlock.rs

@@ -158,6 +158,19 @@ pub type Spinlock<T> = lock_api::Mutex<RawSpinlock, T>;
 /// assert!(spinlock.try_lock().is_some());
 pub type SpinlockGuard<'a, T> = lock_api::MutexGuard<'a, RawSpinlock, T>;
 
+/// Create an unlocked `Spinlock` in a `const` context.
+///
+/// ## Example
+///
+/// ```rust
+/// use spinning_top::{const_spinlock, Spinlock};
+///
+/// static SPINLOCK: Spinlock<i32> = const_spinlock(42);
+/// ```
+pub const fn const_spinlock<T>(val: T) -> Spinlock<T> {
+    Spinlock::const_new(<RawSpinlock as lock_api::RawMutex>::INIT, val)
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;