ArcAsyncRwLock

Struct ArcAsyncRwLock 

Source
pub struct ArcAsyncRwLock<T> { /* private fields */ }
Expand description

Asynchronous Read-Write Lock Wrapper

Provides an encapsulation of asynchronous 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
  • Asynchronously acquires locks, does not block threads
  • Thread-safe, supports multi-threaded sharing
  • Automatic lock management through RAII ensures proper lock release

§Use Cases

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

§Usage Example

use prism3_concurrent::ArcAsyncRwLock;
use std::sync::Arc;

#[tokio::main]
async fn main() {
    let data = ArcAsyncRwLock::new(String::from("Hello"));
    let data = Arc::new(data);

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

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

§Author

Haixing Hu

Implementations§

Source§

impl<T> ArcAsyncRwLock<T>

Source

pub fn new(data: T) -> Self

Creates a new asynchronous read-write lock

§Arguments
  • data - The data to be protected
§Returns

Returns a new ArcAsyncRwLock instance

§Example
use prism3_concurrent::ArcAsyncRwLock;

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

pub async fn with_read_lock<F, R>(&self, f: F) -> R
where F: FnOnce(&T) -> R,

Acquires the read lock and executes an operation

Asynchronously acquires the read lock, executes the provided closure, and then automatically releases the lock. Multiple read operations can execute concurrently.

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

Returns the result of executing the closure

§Example
use prism3_concurrent::ArcAsyncRwLock;

#[tokio::main]
async fn main() {
    let data = ArcAsyncRwLock::new(vec![1, 2, 3]);

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

pub async fn with_write_lock<F, R>(&self, f: F) -> R
where F: FnOnce(&mut T) -> R,

Acquires the write lock and executes an operation

Asynchronously 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

§Example
use prism3_concurrent::ArcAsyncRwLock;

#[tokio::main]
async fn main() {
    let data = ArcAsyncRwLock::new(vec![1, 2, 3]);

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

Trait Implementations§

Source§

impl<T> Clone for ArcAsyncRwLock<T>

Source§

fn clone(&self) -> Self

Clones the asynchronous read-write lock

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

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<T> Freeze for ArcAsyncRwLock<T>

§

impl<T> !RefUnwindSafe for ArcAsyncRwLock<T>

§

impl<T> Send for ArcAsyncRwLock<T>
where T: Send + Sync,

§

impl<T> Sync for ArcAsyncRwLock<T>
where T: Send + Sync,

§

impl<T> Unpin for ArcAsyncRwLock<T>

§

impl<T> !UnwindSafe for ArcAsyncRwLock<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.