Struct Cache 

pub struct Cache<B, CM = NoopConcurrencyManager, O = DisabledOffload> { /* private fields */ }

Pre-configured cache with backend, policy, concurrency manager, and offload manager.

Use Cache::builder() to create a new cache configuration.

Example

use hitbox_fn::Cache;
use hitbox::policy::PolicyConfig;
use hitbox_moka::MokaBackend;
use std::time::Duration;

let backend = MokaBackend::builder().max_entries(1000).build();
let policy = PolicyConfig::builder().ttl(Duration::from_secs(60)).build();

let cache = Cache::builder()
    .backend(backend)
    .policy(policy)
    .build();

// Use with cached functions
let result = my_cached_function(arg1, arg2)
    .cache(&cache)
    .await;

// With offload manager for Stale-While-Revalidate
use hitbox::offload::OffloadManager;

let cache = Cache::builder()
    .backend(backend)
    .policy(policy)
    .offload(OffloadManager::with_defaults())
    .build();

Implementations

impl<B, CM, O> Cache<B, CM, O>

pub fn backend(&self) -> &Arc<B>

Get a reference to the backend Arc.

pub fn policy(&self) -> &Arc<PolicyConfig>

Get a reference to the policy Arc.

pub fn concurrency_manager(&self) -> &CM

Get a reference to the concurrency manager.

pub fn offload(&self) -> &O

Get a reference to the offload manager.

impl Cache<(), NoopConcurrencyManager, DisabledOffload>

pub fn builder() -> CacheBuilder<NoBackend, NoPolicy, NoopConcurrencyManager, DisabledOffload>

Create a new cache builder.

Trait Implementations

impl<B, CM: Clone, O: Clone> CacheAccess for Cache<B, CM, O>

type Backend = B

The cache backend type.

type ConcurrencyManager = CM

The concurrency manager type.

type Offload = O

The offload manager type.

fn backend(&self) -> Arc<B>

Get a shared reference to the backend.

fn policy(&self) -> Arc<PolicyConfig>

Get a shared reference to the policy.

fn concurrency_manager(&self) -> CM

Get the concurrency manager.

fn offload(&self) -> O

Get the offload manager.

impl<B, CM: Clone, O: Clone> Clone for Cache<B, CM, O>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.