solana_type_overrides::sync

Struct MappedRwLockReadGuard

pub struct MappedRwLockReadGuard<'a, T>where
    T: 'a + ?Sized,
{ /* private fields */ }

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

Expand description

RAII structure used to release the shared read access of a lock when dropped, which can point to a subfield of the protected data.

This structure is created by the map and try_map methods on RwLockReadGuard.

Implementations§

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

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

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

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 MappedRwLockReadGuard::map(...). A method would interfere with methods of the same name on the contents of the MappedRwLockReadGuard used through Deref.

§Panics

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

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

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

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 MappedRwLockReadGuard::try_map(...). A method would interfere with methods of the same name on the contents of the MappedRwLockReadGuard used through Deref.

§Panics

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

Trait Implementations§

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

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

Formats the value using the given formatter. Read more

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

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

Formats the value using the given formatter. Read more

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

fn drop(&mut self)

Executes the destructor for this type. Read more

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Auto Trait Implementations§

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

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

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

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

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

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

default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V