Struct RwLock

pub struct RwLock<M, T>
where
    M: RawMutex,
    T: ?Sized,
{ /* private fields */ }

Async read-write lock.

The read-write lock is generic over the raw mutex implementation M and the data T it protects. The raw read-write lock is used to guard access to the internal state. It is held for very short periods only, while locking and unlocking. It is not held for the entire time the async RwLock is locked.

Which implementation you select depends on the context in which you’re using the read-write lock.

Use CriticalSectionRawMutex when data can be shared between threads and interrupts.

Use NoopRawMutex when data is only shared between tasks running on the same executor.

Use ThreadModeRawMutex when data is shared between tasks running on the same executor but you want a singleton.

Implementations

impl<M, T> RwLock<M, T>

where M: RawMutex,

Async read-write lock.

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

Create a new read-write lock with the given value.

impl<M, T> RwLock<M, T>

where M: RawMutex, T: ?Sized,

pub fn read(&self) -> impl Future<Output = RwLockReadGuard<'_, M, T>>

Lock the read-write lock for reading.

This will wait for the lock to be available if it’s already locked for writing.

pub fn write(&self) -> impl Future<Output = RwLockWriteGuard<'_, M, T>>

Lock the read-write lock for writing.

This will wait for the lock to be available if it’s already locked for reading or writing.

pub fn try_read(&self) -> Result<RwLockReadGuard<'_, M, T>, TryLockError>

Attempt to immediately lock the rwlock.

If the rwlock is already locked, this will return an error instead of waiting.

pub fn try_write(&self) -> Result<RwLockWriteGuard<'_, M, T>, TryLockError>

Attempt to immediately lock the rwlock.

If the rwlock is already locked, this will return an error instead of waiting.

pub fn into_inner(self) -> T

where T: Sized,

Consumes this read-write lock, returning the underlying data.

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

Returns a mutable reference to the underlying data.

Since this call borrows the RwLock mutably, no actual locking needs to take place – the mutable borrow statically guarantees no locks exist.

Trait Implementations

impl<M, T> Debug for RwLock<M, T>

where M: RawMutex, T: ?Sized + Debug,

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

Formats the value using the given formatter.

impl<M, T> Default for RwLock<M, T>

where M: RawMutex, T: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<M: RawMutex, T> From<T> for RwLock<M, T>

fn from(from: T) -> Self

Converts to this type from the input type.

impl<M: RawMutex + Send, T: ?Sized + Send> Send for RwLock<M, T>

impl<M: RawMutex + Sync, T: ?Sized + Send> Sync for RwLock<M, T>