Struct TryRwLock

pub struct TryRwLock<T> { /* private fields */ }

A readers-writer lock.

Implementations

impl<T> TryRwLock<T>

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

Create a new unlocked TryRwLock<T>.

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

Attempt to lock this TryRwLock with shared read access.

If the lock is currently being written to or there are usize::MAX existing readers, this function will return None.

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

Attempt to lock this TryRwLock with unique write access.

If the lock is currently being written to or read from, this function will return None.

pub fn into_inner(self) -> T

Get the underlying data of the lock.

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

Get a mutable reference to the underlying data.

As this method takes a mutable reference, no locking needs to take place.

pub fn is_locked(&self) -> bool

Check if the lock is currently locked in any way.

pub fn is_write_locked(&self) -> bool

Check if the lock is currently locked for writing, or if there are usize::MAX readers.

Trait Implementations

impl<T: Debug> Debug for TryRwLock<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for TryRwLock<T>

fn default() -> TryRwLock<T>

Returns the “default value” for a type.

impl<T> From<T> for TryRwLock<T>

fn from(data: T) -> Self

Converts to this type from the input type.

impl<T: Send> Send for TryRwLock<T>

impl<T: Send + Sync> Sync for TryRwLock<T>