Skip to main content

ValueRef

Struct ValueRef 

Source
pub struct ValueRef<'a, V> { /* private fields */ }
Expand description

ValueRef is returned when invoking get method of the Cache. It wraps a parking_lot::MappedRwLockReadGuard projected directly to the inner value, so the shard read lock is held for the lifetime of the ref.

Auto-trait inheritance follows parking_lot’s GuardMarker:

  • Without the send_guard feature (default), the marker is GuardNoSend (a *mut ()), which makes ValueRef neither Send nor Sync. This is the right default for parking_lot, whose RwLock permits same-thread read-guard → write-guard upgrades — sending a guard across threads would break that invariant.
  • With the send_guard feature, parking_lot switches the marker to GuardSend, and ValueRef becomes Send (and Sync when V is) automatically. Enabling that feature opts the whole RwLock family out of guard upgrades — see the parking_lot docs for the trade-offs.

Implementations§

Source§

impl<'a, V> ValueRef<'a, V>

Source

pub fn value(&self) -> &V

Get the reference of the inner value.

Source

pub fn release(self)

Drop self, release the inner RwLockReadGuard, which is the same as drop()

Source

pub fn ttl(&self) -> Duration

Get the expiration time.

Source§

impl<V: Copy> ValueRef<'_, V>

Source

pub fn read(self) -> V

Get the value and drop the inner RwLockReadGuard.

Trait Implementations§

Source§

impl<V> AsRef<V> for ValueRef<'_, V>

Source§

fn as_ref(&self) -> &V

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl<V: Debug> Debug for ValueRef<'_, V>

Source§

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

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

impl<V: Display> Display for ValueRef<'_, V>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, V> Freeze for ValueRef<'a, V>

§

impl<'a, V> RefUnwindSafe for ValueRef<'a, V>
where V: RefUnwindSafe,

§

impl<'a, V> Send for ValueRef<'a, V>
where V: Sync,

§

impl<'a, V> Sync for ValueRef<'a, V>
where V: Sync,

§

impl<'a, V> Unpin for ValueRef<'a, V>

§

impl<'a, V> UnsafeUnpin for ValueRef<'a, V>

§

impl<'a, V> UnwindSafe for ValueRef<'a, V>
where V: RefUnwindSafe,

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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§

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more