Skip to main content

Entry

Struct Entry 

Source
pub struct Entry<V> { /* private fields */ }
Expand description

A cheaply-cloneable handle to a cached value and its metadata.

Entries are immutable; “mutating” an entry (throttling a stale value, refreshing it) produces a new Entry that replaces the old one. This avoids interior mutability and makes every stored value safe to share across tasks.

Implementations§

Source§

impl<V> Entry<V>

Source

pub fn value(&self) -> &V

Borrows the cached value.

Source

pub fn meta(&self) -> &Metadata

The entry’s metadata.

Source

pub fn backend_ttl(&self) -> Duration

The TTL to hand the backend’s expiry policy.

Source

pub fn freshness(&self, now: Timestamp) -> Freshness

Computes freshness relative to now.

Source

pub fn is_logically_expired(&self, now: Timestamp) -> bool

true if the entry is logically expired at now.

Source

pub fn is_physically_expired(&self, now: Timestamp) -> bool

true if now is at/after the physical boundary (the entry is dead and no longer usable even as a fail-safe fallback).

Source

pub fn should_eager_refresh(&self, now: Timestamp) -> bool

true if a proactive background refresh should start now.

Source§

impl<V: Clone> Entry<V>

Source

pub fn value_cloned(&self) -> V

Clones out the cached value.

Source§

impl<V> Entry<V>

Source

pub fn fresh( value: V, options: &EntryOptions, created: Timestamp, tags: Box<[Tag]>, etag: Option<String>, last_modified: Option<Timestamp>, ) -> Self

Builds a fresh entry from a freshly-produced value.

Source

pub fn throttled( source: &Entry<V>, options: &EntryOptions, now: Timestamp, ) -> Option<Self>
where V: Clone,

Builds a throttled fail-safe entry that re-serves an existing value for the throttle window, keeping the original physical boundary.

Returns None when the source value is already physically expired and so cannot be reused.

Source

pub fn with_logical_expiration(&self, at: Timestamp) -> Self
where V: Clone,

Produces a copy of this entry that is logically expired as of at, while keeping the original physical boundary so fail-safe can still serve it. Used by Cache::expire.

Source

pub fn rehydrate( value: V, created: Timestamp, logical_expiration: Timestamp, physical_expiration: Timestamp, is_from_fail_safe: bool, etag: Option<String>, last_modified: Option<Timestamp>, tags: Box<[Tag]>, now: Timestamp, ) -> Self

Rebuilds an in-memory entry from data read out of the L2 distributed cache, recomputing the backend TTL from the (absolute) physical boundary.

Source

pub fn from_fail_safe_default( value: V, options: &EntryOptions, now: Timestamp, ) -> Self

Builds a fail-safe entry from a default value (the fail_safe_default), throttled like throttled.

Trait Implementations§

Source§

impl<V> Clone for Entry<V>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<V: Debug> Debug for Entry<V>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<V> Freeze for Entry<V>
where Arc<EntryInner<V>>: Freeze,

§

impl<V> RefUnwindSafe for Entry<V>
where Arc<EntryInner<V>>: RefUnwindSafe,

§

impl<V> Send for Entry<V>
where Arc<EntryInner<V>>: Send,

§

impl<V> Sync for Entry<V>
where Arc<EntryInner<V>>: Sync,

§

impl<V> Unpin for Entry<V>
where Arc<EntryInner<V>>: Unpin,

§

impl<V> UnsafeUnpin for Entry<V>
where Arc<EntryInner<V>>: UnsafeUnpin,

§

impl<V> UnwindSafe for Entry<V>
where Arc<EntryInner<V>>: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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