Struct CacheEntry

pub struct CacheEntry<T> { /* private fields */ }

A cache entry that employs probabilistic early expiration

Examples

In this example, you can see how to create a new cache entry. The value of the entry is passed in as a closure so the time required for recomputation can be measured. The time to expiration can be set by chaining the with_ttl() method.

use std::time::Duration;
use xfetch::CacheEntry;

let entry = CacheEntry::builder(|| 42)
    .with_ttl(|_| Duration::from_secs(10))
    .build();

See the module-level documentation for more information.

Implementations

impl<T> CacheEntry<T>

pub fn builder<F>(f: F) -> CacheEntryBuilder<T>

where F: FnOnce() -> T,

Return a new CacheEntryBuilder.

This method takes a closure which should return the value to be cached.

pub fn is_expired(&self) -> bool

Check whether the cache has expired or not.

With probabilstic early expiration, this method may return true before the entry is really expired.

pub fn is_eternal(&self) -> bool

Check if the cache entry will never expire.

If the cache entry is created without setting time to expiration then it is a eternal cache entry.

pub fn get(&self) -> &T

Returns a reference of the contained value.

pub fn into_inner(self) -> T

Unwraps the value.

Trait Implementations

impl<T: Clone> Clone for CacheEntry<T>

fn clone(&self) -> CacheEntry<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for CacheEntry<T>