Struct lock_api::ArcRwLockReadGuard

source ·
pub struct ArcRwLockReadGuard<R: RawRwLock, T: ?Sized> { /* private fields */ }
Expand description

An RAII rwlock guard returned by the Arc locking operations on RwLock.

This is similar to the RwLockReadGuard struct, except instead of using a reference to unlock the RwLock it uses an Arc<RwLock>. This has several advantages, most notably that it has an 'static lifetime.

Implementations§

source§

impl<R: RawRwLock, T: ?Sized> ArcRwLockReadGuard<R, T>

source

pub fn rwlock(s: &Self) -> &Arc<RwLock<R, T>>

Returns a reference to the rwlock, contained in its Arc.

source

pub fn unlocked<F, U>(s: &mut Self, f: F) -> U
where F: FnOnce() -> U,

Temporarily unlocks the RwLock to execute the given function.

This is functionally identical to the unlocked method on RwLockReadGuard.

source§

impl<R: RawRwLockFair, T: ?Sized> ArcRwLockReadGuard<R, T>

source

pub fn unlock_fair(s: Self)

Unlocks the RwLock using a fair unlock protocol.

This is functionally identical to the unlock_fair method on RwLockReadGuard.

source

pub fn unlocked_fair<F, U>(s: &mut Self, f: F) -> U
where F: FnOnce() -> U,

Temporarily unlocks the RwLock to execute the given function.

This is functionally identical to the unlocked_fair method on RwLockReadGuard.

source

pub fn bump(s: &mut Self)

Temporarily yields the RwLock to a waiting thread if there is one.

This is functionally identical to the bump method on RwLockReadGuard.

Trait Implementations§

source§

impl<R: RawRwLock, T: Debug + ?Sized> Debug for ArcRwLockReadGuard<R, T>

source§

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

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

impl<R: RawRwLock, T: ?Sized> Deref for ArcRwLockReadGuard<R, T>

§

type Target = T

The resulting type after dereferencing.
source§

fn deref(&self) -> &T

Dereferences the value.
source§

impl<R: RawRwLock, T: Display + ?Sized> Display for ArcRwLockReadGuard<R, T>

source§

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

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

impl<R: RawRwLock, T: ?Sized> Drop for ArcRwLockReadGuard<R, T>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<R, T> Freeze for ArcRwLockReadGuard<R, T>
where T: ?Sized,

§

impl<R, T> !RefUnwindSafe for ArcRwLockReadGuard<R, T>

§

impl<R, T> Send for ArcRwLockReadGuard<R, T>
where <R as RawRwLock>::GuardMarker: Send, R: Sync + Send, T: Send + Sync + ?Sized,

§

impl<R, T> Sync for ArcRwLockReadGuard<R, T>
where <R as RawRwLock>::GuardMarker: Sync, R: Sync + Send, T: Send + Sync + ?Sized,

§

impl<R, T> Unpin for ArcRwLockReadGuard<R, T>
where <R as RawRwLock>::GuardMarker: Unpin, T: ?Sized,

§

impl<R, T> !UnwindSafe for ArcRwLockReadGuard<R, T>

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>,

§

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>,

§

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.