Struct RocketMQTokioRwLock

pub struct RocketMQTokioRwLock<T: ?Sized> { /* private fields */ }

Implementations

impl<T: ?Sized> RocketMQTokioRwLock<T>

pub fn new(data: T) -> Self

where T: Sized,

Creates a new RocketMQTokioRwLock instance containing the given data.

Arguments

• data - The data to be protected by the read-write lock.

Returns

A new RocketMQTokioRwLock instance.

pub fn new_rw_lock(lock: RwLock<T>) -> Self

where T: Sized,

Creates a new RocketMQTokioRwLock instance from an existing tokio::sync::RwLock.

Arguments

• lock - An existing tokio::sync::RwLock to be used.

Returns

A new RocketMQTokioRwLock instance.

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

Acquires a read lock asynchronously, blocking the current task until it is able to do so.

Returns

A RwLockReadGuard that releases the read lock when dropped.

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

Acquires a write lock asynchronously, blocking the current task until it is able to do so.

Returns

A RwLockWriteGuard that releases the write lock when dropped.

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

Attempts to acquire a read lock asynchronously without blocking.

Returns

An Option containing a RwLockReadGuard if the read lock was successfully acquired, or None if the lock is already held.

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

Attempts to acquire a write lock asynchronously without blocking.

Returns

An Option containing a RwLockWriteGuard if the write lock was successfully acquired, or None if the lock is already held.

pub async fn try_read_timeout( &self, timeout: Duration, ) -> Option<RwLockReadGuard<'_, T>>

Attempts to acquire a read lock asynchronously, blocking for up to the specified timeout.

Arguments

• timeout - The maximum duration to wait for the read lock.

Returns

An Option containing a RwLockReadGuard if the read lock was successfully acquired within the timeout, or None if the timeout expired.

pub async fn try_write_timeout( &self, timeout: Duration, ) -> Option<RwLockWriteGuard<'_, T>>

Attempts to acquire a write lock asynchronously, blocking for up to the specified timeout.

Arguments

• timeout - The maximum duration to wait for the write lock.

Returns

An Option containing a RwLockWriteGuard if the write lock was successfully acquired within the timeout, or None if the timeout expired.

Trait Implementations

impl<T> Default for RocketMQTokioRwLock<T>

where T: Default,

fn default() -> Self

Returns the “default value” for a type.