Struct std::sync::RwLockReadGuard

1.0.0 · source ·
pub struct RwLockReadGuard<'a, T: ?Sized + 'a> { /* private fields */ }
Expand description

RAII structure used to release the shared read access of a lock when dropped.

This structure is created by the read and try_read methods on RwLock.

Implementations§

source§

impl<'a, T: ?Sized> RwLockReadGuard<'a, T>

source

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

🔬This is a nightly-only experimental API. (mapped_lock_guards #117108)

Makes a MappedRwLockReadGuard for a component of the borrowed data, e.g. an enum variant.

The RwLock is already locked for reading, so this cannot fail.

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

§Panics

If the closure panics, the guard will be dropped (unlocked) and the RwLock will not be poisoned.

source

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

🔬This is a nightly-only experimental API. (mapped_lock_guards #117108)

Makes a MappedRwLockReadGuard for a component of the borrowed data. The original guard is returned as an Err(...) if the closure returns None.

The RwLock is already locked for reading, so this cannot fail.

This is an associated function that needs to be used as RwLockReadGuard::try_map(...). A method would interfere with methods of the same name on the contents of the RwLockReadGuard used through Deref.

§Panics

If the closure panics, the guard will be dropped (unlocked) and the RwLock will not be poisoned.

Trait Implementations§

1.16.0 · source§

impl<T: ?Sized + Debug> Debug for RwLockReadGuard<'_, T>

source§

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

Formats the value using the given formatter. Read more
1.0.0 · source§

impl<T: ?Sized> Deref for RwLockReadGuard<'_, T>

source§

type Target = T

The resulting type after dereferencing.
source§

fn deref(&self) -> &T

Dereferences the value.
1.20.0 · source§

impl<T: ?Sized + Display> Display for RwLockReadGuard<'_, T>

source§

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

Formats the value using the given formatter. Read more
1.0.0 · source§

impl<T: ?Sized> Drop for RwLockReadGuard<'_, T>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
1.0.0 · source§

impl<T: ?Sized> !Send for RwLockReadGuard<'_, T>

1.23.0 · source§

impl<T: ?Sized + Sync> Sync for RwLockReadGuard<'_, T>

Auto Trait Implementations§

§

impl<'a, T> Freeze for RwLockReadGuard<'a, T>
where T: ?Sized,

§

impl<'a, T> RefUnwindSafe for RwLockReadGuard<'a, T>
where T: RefUnwindSafe + ?Sized,

§

impl<'a, T> Unpin for RwLockReadGuard<'a, T>
where T: ?Sized,

§

impl<'a, T> UnwindSafe for RwLockReadGuard<'a, T>
where T: RefUnwindSafe + ?Sized,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.