Struct peace_lock::RwLock

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

A read-write lock

Implementations

impl<T> RwLock<T>

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

Create a new RwLock.

pub fn into_inner(self) -> T

Consume the RwLock, returning the inner value.

impl<T> RwLock<T>where T: ?Sized,

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

Get a mutable reference of the inner value T. This is safe because we have the mutable reference of the lock.

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

Try write lock the RwLock, returns the write guard. Returns None if the RwLock is write locked.

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

Write lock the RwLock, returns the write guard.

Panics

If the RwLock is already write locked, this will panic if the check feature is turned on.

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

Try read lock the RwLock, returns the read guard. Returns None if the RwLock is write locked.

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

Read lock the RwLock, returns the read guard.

Panics

If the RwLock is already write locked, this will panic if the check feature is turned on.

Trait Implementations

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

fn from(val: T) -> Self

Converts to this type from the input type.

impl<T> RefUnwindSafe for RwLock<T>where T: ?Sized,

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

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

impl<T> UnwindSafe for RwLock<T>where T: ?Sized,