Struct spinning_top::RawSpinlock

pub struct RawSpinlock<R: Relax = Spin> { /* private fields */ }

Provides mutual exclusion based on spinning on an AtomicBool.

It’s recommended to use this type either combination with lock_api::Mutex or through the Spinlock type.

Example

use lock_api::RawMutex;
use spinning_top::RawSpinlock;

let lock: RawSpinlock = RawSpinlock::INIT;
assert_eq!(lock.try_lock(), true); // lock it
assert_eq!(lock.try_lock(), false); // can't be locked a second time
unsafe { lock.unlock(); } // unlock it
assert_eq!(lock.try_lock(), true); // now it can be locked again

Trait Implementations

impl<R: Debug + Relax> Debug for RawSpinlock<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R: Relax> RawMutex for RawSpinlock<R>

const INIT: RawSpinlock<R> = _

Initial value for an unlocked mutex.

type GuardMarker = GuardSend

Marker type which determines whether a lock guard should be Send. Use one of the GuardSend or GuardNoSend helper types here.

fn lock(&self)

Acquires this mutex, blocking the current thread until it is able to do so.

fn try_lock(&self) -> bool

Attempts to acquire this mutex without blocking. Returns true if the lock was successfully acquired and false otherwise.

unsafe fn unlock(&self)

Unlocks this mutex.

fn is_locked(&self) -> bool

Checks whether the mutex is currently locked.