SpinLock

Struct SpinLock 

Source
pub struct SpinLock<T> {
    locked: AtomicBool,
    inner: UnsafeCell<T>,
}
Expand description

A tiny spinlock for short critical sections.

This lock is suitable for uniprocessor or early boot stages where:

  • Preemption is either disabled or non-existent.
  • Critical sections are very short (no I/O, no blocking).

§Guarantees

  • Provides mutual exclusion for access to the protected value.
  • Sync is implemented when T: Send, allowing shared references across threads (the lock enforces interior mutability).

§Caveats

  • Does not disable interrupts.
  • Busy-waits with spin_loop, so keep critical sections small.

Fields§

§locked: AtomicBool

Lock state (false = unlocked, true = locked).

§inner: UnsafeCell<T>

The protected value.

Implementations§

Source§

impl<T> SpinLock<T>

Source

pub const fn new(inner: T) -> Self

Create a new spinlock wrapping inner.

Source

pub fn with_lock<R>(&self, f: impl FnOnce(&mut T) -> R) -> R

Execute f with exclusive access to the inner value.

Spins until the lock is acquired, then releases it after f returns.

§Panics

Never panics by itself; panics in f will unwind through the critical section.

Trait Implementations§

Source§

impl<T: Send> Sync for SpinLock<T>

Auto Trait Implementations§

§

impl<T> !Freeze for SpinLock<T>

§

impl<T> !RefUnwindSafe for SpinLock<T>

§

impl<T> Send for SpinLock<T>
where T: Send,

§

impl<T> Unpin for SpinLock<T>
where T: Unpin,

§

impl<T> UnwindSafe for SpinLock<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.