Skip to main content

TtlCache

Struct TtlCache 

Source
pub struct TtlCache<K, V> { /* private fields */ }
Expand description

Thread-safe TTL cache with LRU eviction.

The cache is keyed by any Eq + Hash + Clone type and stores any Clone value. Each insert takes a per-entry TTL. Entries expire on the first get/insert that observes the expired deadline; an explicit TtlCache::prune is also provided for bulk collection.

Implementations§

Source§

impl<K, V> TtlCache<K, V>
where K: Eq + Hash + Clone, V: Clone,

Source

pub fn new(capacity: NonZero<usize>) -> TtlCache<K, V>

Create a new cache with the given capacity, backed by TokioClock.

Capacity is a non-zero usize because a zero-capacity cache is degenerate (every insert would immediately evict itself).

Source

pub fn with_clock( capacity: NonZero<usize>, clock: Arc<dyn Clock>, ) -> TtlCache<K, V>

Create a cache backed by a custom Clock implementation.

Source

pub fn capacity(&self) -> usize

Configured maximum number of live entries.

Source

pub fn len(&self) -> usize

Current number of entries in the cache (may include not-yet-pruned expired entries).

Source

pub fn is_empty(&self) -> bool

Returns true when the cache holds no entries.

Source

pub fn get(&self, key: &K) -> Option<V>

Look up key. Returns Some(value) on cache hit (and bumps the entry’s recency); None on miss or expired entry. Expired entries are removed on observation.

Source

pub fn insert(&self, key: K, value: V, ttl: Duration)

Insert value under key with the given ttl. If the cache is at capacity, evicts the least recently used live entry first.

Source

pub fn prune(&self) -> usize

Remove every entry whose TTL has expired relative to the clock’s current “now”. Returns the number of entries removed.

Source

pub fn clear(&self)

Remove all entries.

Auto Trait Implementations§

§

impl<K, V> !Freeze for TtlCache<K, V>

§

impl<K, V> !RefUnwindSafe for TtlCache<K, V>

§

impl<K, V> Send for TtlCache<K, V>
where K: Send, V: Send,

§

impl<K, V> Sync for TtlCache<K, V>
where K: Send, V: Send,

§

impl<K, V> Unpin for TtlCache<K, V>
where K: Unpin, V: Unpin,

§

impl<K, V> UnsafeUnpin for TtlCache<K, V>

§

impl<K, V> !UnwindSafe for TtlCache<K, V>

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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