Struct ArcRwLock 

pub struct ArcRwLock<T> { /* private fields */ }

Synchronous Read-Write Lock Wrapper

Provides an encapsulation of synchronous read-write lock, supporting multiple read operations or a single write operation. Read operations can execute concurrently, while write operations have exclusive access.

Features

• Supports multiple concurrent read operations
• Write operations have exclusive access, mutually exclusive with read operations
• Synchronously acquires locks, may block threads
• Thread-safe, supports multi-threaded sharing
• Automatic lock management through RAII ensures proper lock release
• Implements Deref and AsRef to expose the underlying std::sync::RwLock API when guard-based access is needed

Use Cases

Suitable for read-heavy scenarios such as caching, configuration management, etc.

Usage Example

use qubit_lock::lock::{ArcRwLock, Lock};

let data = ArcRwLock::new(String::from("Hello"));

// Multiple read operations can execute concurrently
data.read(|s| {
    println!("Read: {}", s);
});

// Write operations have exclusive access
data.write(|s| {
    s.push_str(" World!");
    println!("Write: {}", s);
});

Implementations

impl<T> ArcRwLock<T>

pub fn new(data: T) -> Self

Creates a new synchronous read-write lock

Arguments

• data - The data to be protected

Returns

Returns a new ArcRwLock instance

Example

use qubit_lock::lock::ArcRwLock;

let rw_lock = ArcRwLock::new(vec![1, 2, 3]);

Methods from Deref<Target = RwLock<T>>

pub fn get_cloned(&self) -> Result<T, PoisonError<()>>

where T: Clone,

🔬This is a nightly-only experimental API. (lock_value_accessors)

Returns the contained value by cloning it.

Errors

This function will return an error if the RwLock is poisoned. An RwLock is poisoned whenever a writer panics while holding an exclusive lock.

Examples

#![feature(lock_value_accessors)]

use std::sync::RwLock;

let mut lock = RwLock::new(7);

assert_eq!(lock.get_cloned().unwrap(), 7);

pub fn set(&self, value: T) -> Result<(), PoisonError<T>>

🔬This is a nightly-only experimental API. (lock_value_accessors)

Sets the contained value.

Errors

This function will return an error containing the provided value if the RwLock is poisoned. An RwLock is poisoned whenever a writer panics while holding an exclusive lock.

Examples

#![feature(lock_value_accessors)]

use std::sync::RwLock;

let mut lock = RwLock::new(7);

assert_eq!(lock.get_cloned().unwrap(), 7);
lock.set(11).unwrap();
assert_eq!(lock.get_cloned().unwrap(), 11);

pub fn replace(&self, value: T) -> Result<T, PoisonError<T>>

🔬This is a nightly-only experimental API. (lock_value_accessors)

Replaces the contained value with value, and returns the old contained value.

Errors

This function will return an error containing the provided value if the RwLock is poisoned. An RwLock is poisoned whenever a writer panics while holding an exclusive lock.

Examples

#![feature(lock_value_accessors)]

use std::sync::RwLock;

let mut lock = RwLock::new(7);

assert_eq!(lock.replace(11).unwrap(), 7);
assert_eq!(lock.get_cloned().unwrap(), 11);

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

Locks this RwLock with shared read access, blocking the current thread until it can be acquired.

The calling thread will be blocked until there are no more writers which hold the lock. There may be other readers currently inside the lock when this method returns. This method does not provide any guarantees with respect to the ordering of whether contentious readers or writers will acquire the lock first.

Returns an RAII guard which will release this thread’s shared access once it is dropped.

Errors

This function will return an error if the RwLock is poisoned. An RwLock is poisoned whenever a writer panics while holding an exclusive lock. The failure will occur immediately after the lock has been acquired. The acquired lock guard will be contained in the returned error.

Panics

This function might panic when called if the lock is already held by the current thread in read or write mode.

Examples

use std::sync::{Arc, RwLock};
use std::thread;

let lock = Arc::new(RwLock::new(1));
let c_lock = Arc::clone(&lock);

let n = lock.read().unwrap();
assert_eq!(*n, 1);

thread::spawn(move || {
    let r = c_lock.read();
    assert!(r.is_ok());
}).join().unwrap();

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

Attempts to acquire this RwLock with shared read access.

If the access could not be granted at this time, then Err is returned. Otherwise, an RAII guard is returned which will release the shared access when it is dropped.

This function does not block.

This function does not provide any guarantees with respect to the ordering of whether contentious readers or writers will acquire the lock first.

Errors

This function will return the Poisoned error if the RwLock is poisoned. An RwLock is poisoned whenever a writer panics while holding an exclusive lock. Poisoned will only be returned if the lock would have otherwise been acquired. An acquired lock guard will be contained in the returned error.

This function will return the WouldBlock error if the RwLock could not be acquired because it was already locked exclusively.

Examples

use std::sync::RwLock;

let lock = RwLock::new(1);

match lock.try_read() {
    Ok(n) => assert_eq!(*n, 1),
    Err(_) => unreachable!(),
};

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

Locks this RwLock with exclusive write access, blocking the current thread until it can be acquired.

This function will not return while other writers or other readers currently have access to the lock.

Returns an RAII guard which will drop the write access of this RwLock when dropped.

Errors

This function will return an error if the RwLock is poisoned. An RwLock is poisoned whenever a writer panics while holding an exclusive lock. An error will be returned when the lock is acquired. The acquired lock guard will be contained in the returned error.

Panics

This function might panic when called if the lock is already held by the current thread in read or write mode.

Examples

use std::sync::RwLock;

let lock = RwLock::new(1);

let mut n = lock.write().unwrap();
*n = 2;

assert!(lock.try_read().is_err());

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

Attempts to lock this RwLock with exclusive write access.

If the lock could not be acquired at this time, then Err is returned. Otherwise, an RAII guard is returned which will release the lock when it is dropped.

This function does not block.

This function does not provide any guarantees with respect to the ordering of whether contentious readers or writers will acquire the lock first.

Errors

This function will return the Poisoned error if the RwLock is poisoned. An RwLock is poisoned whenever a writer panics while holding an exclusive lock. Poisoned will only be returned if the lock would have otherwise been acquired. An acquired lock guard will be contained in the returned error.

This function will return the WouldBlock error if the RwLock could not be acquired because it was already locked.

Examples

use std::sync::RwLock;

let lock = RwLock::new(1);

let n = lock.read().unwrap();
assert_eq!(*n, 1);

assert!(lock.try_write().is_err());

pub fn is_poisoned(&self) -> bool

Determines whether the lock is poisoned.

If another thread is active, the lock can still become poisoned at any time. You should not trust a false value for program correctness without additional synchronization.

Examples

use std::sync::{Arc, RwLock};
use std::thread;

let lock = Arc::new(RwLock::new(0));
let c_lock = Arc::clone(&lock);

let _ = thread::spawn(move || {
    let _lock = c_lock.write().unwrap();
    panic!(); // the lock gets poisoned
}).join();
assert_eq!(lock.is_poisoned(), true);

pub fn clear_poison(&self)

Clear the poisoned state from a lock.

If the lock is poisoned, it will remain poisoned until this function is called. This allows recovering from a poisoned state and marking that it has recovered. For example, if the value is overwritten by a known-good value, then the lock can be marked as un-poisoned. Or possibly, the value could be inspected to determine if it is in a consistent state, and if so the poison is removed.

Examples

use std::sync::{Arc, RwLock};
use std::thread;

let lock = Arc::new(RwLock::new(0));
let c_lock = Arc::clone(&lock);

let _ = thread::spawn(move || {
    let _lock = c_lock.write().unwrap();
    panic!(); // the lock gets poisoned
}).join();

assert_eq!(lock.is_poisoned(), true);
let guard = lock.write().unwrap_or_else(|mut e| {
    **e.get_mut() = 1;
    lock.clear_poison();
    e.into_inner()
});
assert_eq!(lock.is_poisoned(), false);
assert_eq!(*guard, 1);

pub fn data_ptr(&self) -> *mut T

🔬This is a nightly-only experimental API. (rwlock_data_ptr)

Returns a raw pointer to the underlying data.

The returned pointer is always non-null and properly aligned, but it is the user’s responsibility to ensure that any reads and writes through it are properly synchronized to avoid data races, and that it is not read or written through after the lock is dropped.

Trait Implementations

impl<T> AsRef<RwLock<T>> for ArcRwLock<T>

fn as_ref(&self) -> &RwLock<T>

Returns a reference to the underlying standard read-write lock.

This is useful when callers need guard-based APIs such as RwLock::read or RwLock::write instead of the closure-based Lock methods.

impl<T> Clone for ArcRwLock<T>

fn clone(&self) -> Self

Clones the synchronous read-write lock

Creates a new ArcRwLock instance that shares the same underlying lock with the original instance. This allows multiple threads to hold references to the same lock simultaneously.

Returns

A new handle sharing the same underlying read-write lock and protected value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Deref for ArcRwLock<T>

fn deref(&self) -> &Self::Target

Dereferences this wrapper to the underlying standard read-write lock.

When Lock is in scope, read and write with closure arguments still call the trait methods on this wrapper. Use explicit dereferencing or AsRef::as_ref when you want the native guard-based RwLock methods.

type Target = RwLock<T>

The resulting type after dereferencing.

impl<T> Lock<T> for ArcRwLock<T>

fn read<R, F>(&self, f: F) -> R

where F: FnOnce(&T) -> R,

Acquires a read lock and executes an operation

Synchronously acquires the read lock, executes the provided closure, and then automatically releases the lock. Multiple read operations can execute concurrently, providing better performance for read-heavy workloads.

Arguments

• f - The closure to be executed while holding the read lock, can only read data

Returns

Returns the result of executing the closure

Panics

Panics if the underlying standard read-write lock is poisoned.

Example

use qubit_lock::lock::{ArcRwLock, Lock};

let data = ArcRwLock::new(vec![1, 2, 3]);

let length = data.read(|v| v.len());
println!("Vector length: {}", length);

fn write<R, F>(&self, f: F) -> R

where F: FnOnce(&mut T) -> R,

Acquires a write lock and executes an operation

Synchronously acquires the write lock, executes the provided closure, and then automatically releases the lock. Write operations have exclusive access, mutually exclusive with read operations.

Arguments

• f - The closure to be executed while holding the write lock, can modify data

Returns

Returns the result of executing the closure

Panics

Panics if the underlying standard read-write lock is poisoned.

Example

use qubit_lock::lock::{ArcRwLock, Lock};

let data = ArcRwLock::new(vec![1, 2, 3]);

data.write(|v| {
    v.push(4);
    println!("Added element, new length: {}", v.len());
});

fn try_read<R, F>(&self, f: F) -> Result<R, TryLockError>

where F: FnOnce(&T) -> R,

Attempts to acquire a read lock without blocking

Attempts to immediately acquire the read lock. If the lock is unavailable, returns a detailed error. This is a non-blocking operation.

Arguments

• f - The closure to be executed while holding the read lock

Returns

• Ok(R) - If the lock was successfully acquired and the closure executed
• Err(TryLockError::WouldBlock) - If the lock is currently held in write mode
• Err(TryLockError::Poisoned) - If the lock is poisoned

Example

use qubit_lock::lock::{ArcRwLock, Lock};

let data = ArcRwLock::new(vec![1, 2, 3]);

if let Ok(length) = data.try_read(|v| v.len()) {
    println!("Vector length: {}", length);
} else {
    println!("Lock is unavailable");
}

fn try_write<R, F>(&self, f: F) -> Result<R, TryLockError>

where F: FnOnce(&mut T) -> R,

Attempts to acquire a write lock without blocking

Attempts to immediately acquire the write lock. If the lock is unavailable, returns a detailed error. This is a non-blocking operation.

Arguments

• f - The closure to be executed while holding the write lock

Returns

• Ok(R) - If the lock was successfully acquired and the closure executed
• Err(TryLockError::WouldBlock) - If the lock is currently held by another thread
• Err(TryLockError::Poisoned) - If the lock is poisoned

Example

use qubit_lock::lock::{ArcRwLock, Lock};

let data = ArcRwLock::new(vec![1, 2, 3]);

if let Ok(new_length) = data.try_write(|v| {
    v.push(4);
    v.len()
}) {
    println!("New length: {}", new_length);
} else {
    println!("Lock is unavailable");
}