Struct RawMutex

pub struct RawMutex { /* private fields */ }

Available on crate feature multitask only.

A [lock_api::RawMutex] implementation.

When the mutex is locked, the current task will block and be put into the wait queue. When the mutex is unlocked, all tasks waiting on the queue will be woken up.

Implementations

impl RawMutex

pub const fn new() -> Self

Creates a RawMutex.

Trait Implementations

impl RawMutex for RawMutex

const INIT: Self

Initial value for an unlocked mutex.

A “non-constant” const item is a legacy way to supply an initialized value to downstream static items. Can hopefully be replaced with const fn new() -> Self at some point.

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.