Struct static_locks::MappedRwLockReadGuard

#[must_use = "if unused the RwLock will immediately unlock"]
pub struct MappedRwLockReadGuard<'a, T: ?Sized> { /* fields omitted */ }

An RAII read lock guard returned by RwLockReadGuard::map, which can point to a subfield of the protected data.

The main difference between MappedRwLockReadGuard and RwLockReadGuard is that the former doesn't support temporarily unlocking and re-locking, since that could introduce soundness issues if the locked object is modified by another thread.

Methods

impl<'a, T: ?Sized + 'a> MappedRwLockReadGuard<'a, T>

pub fn map<U: ?Sized, F>(s: Self, f: F) -> MappedRwLockReadGuard<'a, U> where
    F: FnOnce(&T) -> &U, 

Make a new MappedRwLockReadGuard for a component of the locked data.

This operation cannot fail as the MappedRwLockReadGuard passed in already locked the data.

This is an associated function that needs to be used as MappedRwLockReadGuard::map(...). A method would interfere with methods of the same name on the contents of the locked data.

pub fn try_map<U: ?Sized, F>(
    s: Self,
    f: F
) -> Result<MappedRwLockReadGuard<'a, U>, Self> where
    F: FnOnce(&T) -> Option<&U>, 

Attempts to make a new MappedRwLockReadGuard for a component of the locked data. The original guard is return if the closure returns None.

This operation cannot fail as the MappedRwLockReadGuard passed in already locked the data.

This is an associated function that needs to be used as MappedRwLockReadGuard::map(...). A method would interfere with methods of the same name on the contents of the locked data.

impl<'a, T: ?Sized + 'a> MappedRwLockReadGuard<'a, T>

pub fn unlock_fair(s: Self)

Unlocks the RwLock using a fair unlock protocol.

By default, RwLock is unfair and allow the current thread to re-lock the RwLock before another has the chance to acquire the lock, even if that thread has been blocked on the RwLock for a long time. This is the default because it allows much higher throughput as it avoids forcing a context switch on every RwLock unlock. This can result in one thread acquiring a RwLock many more times than other threads.

However in some cases it can be beneficial to ensure fairness by forcing the lock to pass on to a waiting thread if there is one. This is done by using this method instead of dropping the MappedRwLockReadGuard normally.

Trait Implementations

impl<'a, T: ?Sized + Sync + 'a> Sync for MappedRwLockReadGuard<'a, T>

impl<'a, T: ?Sized + 'a> Drop for MappedRwLockReadGuard<'a, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T: ?Sized + 'a> Deref for MappedRwLockReadGuard<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T: Debug + ?Sized + 'a> Debug for MappedRwLockReadGuard<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: Display + ?Sized + 'a> Display for MappedRwLockReadGuard<'a, T>

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

Formats the value using the given formatter.