Struct Builder 

pub struct Builder { /* private fields */ }

A builder used to configure and construct a CuckooCache.

Implementations

impl Builder

pub fn item_size(self, bytes: usize) -> Self

Set the fixed size in bytes for each item slot. Key, value, and per-item overhead must fit within this size.

use cuckoo_cache::CuckooCache;

let cache = CuckooCache::builder().item_size(128).build();

pub fn nitem(self, nitem: usize) -> Self

Set the maximum number of items the cache can hold.

use cuckoo_cache::CuckooCache;

let cache = CuckooCache::builder().nitem(4096).build();

pub fn max_displace(self, depth: usize) -> Self

Set the maximum displacement depth during insertion. Higher values reduce evictions at the cost of longer worst-case insertion times.

use cuckoo_cache::CuckooCache;

let cache = CuckooCache::builder().max_displace(4).build();

pub fn policy(self, policy: Policy) -> Self

Set the eviction policy.

use cuckoo_cache::{CuckooCache, Policy};

let cache = CuckooCache::builder().policy(Policy::Expire).build();

pub fn max_ttl(self, seconds: u32) -> Self

Set the maximum TTL in seconds. Items with a TTL exceeding this value will have their TTL clamped.

use cuckoo_cache::CuckooCache;

let cache = CuckooCache::builder().max_ttl(86400).build();

pub fn build(self) -> CuckooCache

Consume the builder and allocate a CuckooCache.

use cuckoo_cache::{CuckooCache, Policy};

let cache = CuckooCache::builder()
    .nitem(4096)
    .item_size(64)
    .policy(Policy::Random)
    .build();

Trait Implementations

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.