Struct RwLock

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

A wrapper around std::sync::RwLock that panics on poison.

This RwLock works similarly to the standard library’s RwLock, except its read and write methods do not return a Result. Instead, if the lock is poisoned, it will panic.

Examples

use matrix_sdk_common::locks::RwLock;

let lock = RwLock::new(42);

{
    let read_guard = lock.read();
    assert_eq!(*read_guard, 42);
}
{
    let mut write_guard = lock.write();
    *write_guard = 100;
}
assert_eq!(*lock.read(), 100);

Implementations

impl<T> RwLock<T>

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

Creates a new RwLock wrapping the given value.

impl<T: ?Sized> RwLock<T>

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

Acquires a mutable write lock, panicking if the lock is poisoned.

This method blocks the current thread until the lock is acquired.

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

Acquires a shared read lock, panicking if the lock is poisoned.

This method blocks the current thread until the lock is acquired.

Trait Implementations

impl<T: ?Sized + Debug> Debug for RwLock<T>

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

Formats the value using the given formatter.

impl<T: Default + ?Sized> Default for RwLock<T>

fn default() -> RwLock<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for RwLock<T>

where T: Deserialize<'de> + ?Sized,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<T> for RwLock<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T> Serialize for RwLock<T>

where T: Serialize + ?Sized,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.