Struct mycelium_util::sync::spin::Spinlock

pub struct Spinlock { /* private fields */ }

A spinlock-based RawMutex implementation.

This mutex will spin with an exponential backoff while waiting for the lock to become available.

This type implements the RawMutex and ScopedRawMutex traits from the [mutex-traits] crate. This allows it to be used with the blocking::Mutex type when a spinlock-based mutex is needed.

Implementations

impl Spinlock

pub const fn new() -> Spinlock

Available on non-loom only.

Returns a new Spinlock, in the unlocked state.

Trait Implementations

impl ConstInit for Spinlock

Available on non-loom only.

const INIT: Spinlock = _

Create a new instance.

impl Debug for Spinlock

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

Formats the value using the given formatter.

impl Default for Spinlock

fn default() -> Spinlock

Returns the “default value” for a type.

impl RawMutex for Spinlock

type GuardMarker = ()

Marker type which determines whether a lock guard should be Send.

fn lock(&self)

Acquires this mutex, blocking the current thread/CPU core 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

Returns true if the mutex is currently locked.