Struct CacheBuilder 

pub struct CacheBuilder<B, P, CM, O> { /* private fields */ }

Builder for Cache with typestate pattern.

The builder ensures at compile time that both backend and policy are configured before the cache can be built.

Implementations

impl<P, CM, O> CacheBuilder<NoBackend, P, CM, O>

pub fn backend<B: CacheBackend>( self, backend: B, ) -> CacheBuilder<WithBackend<B>, P, CM, O>

Set the cache backend.

Example

let builder = Cache::builder()
    .backend(MokaBackend::builder().build());

impl<B, CM, O> CacheBuilder<B, NoPolicy, CM, O>

pub fn policy(self, policy: PolicyConfig) -> CacheBuilder<B, WithPolicy, CM, O>

Set the cache policy configuration.

Example

let builder = Cache::builder()
    .policy(PolicyConfig::builder().ttl(Duration::from_secs(60)).build());

impl<B, P, CM, O> CacheBuilder<B, P, CM, O>

pub fn concurrency_manager<CM2>(self, cm: CM2) -> CacheBuilder<B, P, CM2, O>

Set the concurrency manager for dogpile prevention.

By default, NoopConcurrencyManager is used which doesn’t prevent dogpile. Use BroadcastConcurrencyManager for production workloads.

Example

use hitbox::concurrency::BroadcastConcurrencyManager;

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

pub fn offload<O2>(self, offload: O2) -> CacheBuilder<B, P, CM, O2>

Set the offload manager for background task execution.

By default, DisabledOffload is used which disables background revalidation. Use OffloadManager to enable Stale-While-Revalidate pattern.

Example

use hitbox::offload::OffloadManager;

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

impl<B, CM, O> CacheBuilder<WithBackend<B>, WithPolicy, CM, O>

where B: CacheBackend,

pub fn build(self) -> Cache<B, CM, O>

Build the cache configuration.

This method is only available when both backend and policy are configured.