Struct SpinRwLock 

pub struct SpinRwLock<T>(/* private fields */)
where
    T: ?Sized;

A non-sleeping read-write lock with acquisition-site context policy.

Implementations

impl<T> SpinRwLock<T>

pub const fn new(data: T) -> SpinRwLock<T>

Creates an unlocked spin read-write lock.

pub fn into_inner(self) -> T

Consumes the lock and returns the protected value.

impl<T> SpinRwLock<T>

where T: ?Sized,

pub fn read(&self) -> BaseSpinRwLockReadGuard<'_, PreemptState, T>

Acquires a read guard after disabling preemption.

pub fn try_read(&self) -> Option<BaseSpinRwLockReadGuard<'_, PreemptState, T>>

Attempts a read acquisition after disabling preemption.

pub fn write(&self) -> BaseSpinRwLockWriteGuard<'_, PreemptState, T>

Acquires a write guard after disabling preemption.

pub fn try_write(&self) -> Option<BaseSpinRwLockWriteGuard<'_, PreemptState, T>>

Attempts a write acquisition after disabling preemption.

pub fn read_irqsave( &self, ) -> BaseSpinRwLockReadGuard<'_, PreemptIrqSaveState, T>

Acquires an IRQ-save read guard.

pub fn try_read_irqsave( &self, ) -> Option<BaseSpinRwLockReadGuard<'_, PreemptIrqSaveState, T>>

Attempts an IRQ-save read acquisition.

pub fn write_irqsave( &self, ) -> BaseSpinRwLockWriteGuard<'_, PreemptIrqSaveState, T>

Acquires an IRQ-save write guard.

pub fn try_write_irqsave( &self, ) -> Option<BaseSpinRwLockWriteGuard<'_, PreemptIrqSaveState, T>>

Attempts an IRQ-save write acquisition.

pub unsafe fn read_raw(&self) -> BaseSpinRwLockReadGuard<'_, RawState, T>

Acquires a raw read guard without changing execution context.

Safety

The caller must prevent re-entry and uphold the read-side exclusion contract, including on single-core builds.

pub unsafe fn try_read_raw( &self, ) -> Option<BaseSpinRwLockReadGuard<'_, RawState, T>>

Attempts a raw read acquisition.

Safety

The caller must uphold the contract of Self::read_raw.

pub unsafe fn write_raw(&self) -> BaseSpinRwLockWriteGuard<'_, RawState, T>

Acquires a raw write guard without changing execution context.

Safety

The caller must prevent re-entry and concurrent readers or writers, including on single-core builds.

pub unsafe fn try_write_raw( &self, ) -> Option<BaseSpinRwLockWriteGuard<'_, RawState, T>>

Attempts a raw write acquisition.

Safety

The caller must uphold the contract of Self::write_raw.

pub fn get_mut(&mut self) -> &mut T

Returns mutable access without locking.

Trait Implementations

impl<T> Debug for SpinRwLock<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for SpinRwLock<T>

where T: Default,

fn default() -> SpinRwLock<T>

Returns the “default value” for a type.

impl<T> From<T> for SpinRwLock<T>

fn from(value: T) -> SpinRwLock<T>

Converts to this type from the input type.