Struct RwLock

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

A reader-writer lock synchronization primitive. This type allows multiple readers or one writer at a time.

This is different from a Mutex because it allows for multiple readers at the same time.

Implementations

impl<T> RwLock<T>

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

Creates a new reader-writer lock.

impl<T: ?Sized> RwLock<T>

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

Obtains a read lock on the data. Multiple read locks can be held at the same time.

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

Obtains a write lock on the data. Only one write lock can be held at a time.

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

Attempt to gain a read lock on the data.

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

Attempt to gain a write lock on the data.

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

Get mutable access to the data stored in the read-write lock. This doesn’t require a lock to be acquired because the borrow checker guarantees exclusive access because self is a mutable reference.

pub fn into_inner(self) -> T

where T: Sized,

Consumes the read-write lock and returns the inner data.

Trait Implementations

impl<T: Debug> Debug for RwLock<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for RwLock<T>

fn default() -> Self

Returns the “default value” for a type.

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

fn from(data: T) -> Self

Converts to this type from the input type.

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

impl<T: ?Sized + Send + Sync> Sync for RwLock<T>