Struct RwLock

pub struct RwLock<T>(/* private fields */);

Async reader–writer lock.

Powered by async_lock::RwLock, RwLock provides both fair writer acquisition and try_read / try_write without waiting (without any runtime-specific dependencies).

Usage:

use commonware_runtime::{Spawner, Runner, Signaler, deterministic, RwLock};

let executor = deterministic::Runner::default();
executor.start(|context| async move {
    // Create a new RwLock
    let lock = RwLock::new(2);

    // many concurrent readers
    let r1 = lock.read().await;
    let r2 = lock.read().await;
    assert_eq!(*r1 + *r2, 4);

    // exclusive writer
    drop((r1, r2));
    let mut w = lock.write().await;
    *w += 1;
});

Implementations

impl<T> RwLock<T>

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

Create a new lock.

pub async fn read(&self) -> RwLockReadGuard<'_, T>

Acquire a shared read guard.

pub async fn write(&self) -> RwLockWriteGuard<'_, T>

Acquire an exclusive write guard.

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

Try to get a read guard without waiting.

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

Try to get a write guard without waiting.

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

Get mutable access without locking (requires &mut self).

pub fn into_inner(self) -> T

Consume the lock, returning the inner value.