Struct CacheConfig 

pub struct CacheConfig { /* private fields */ }

Tuning for a CachedIndex — the Tier-2 configured path.

Build one with CacheConfig::new and the chaining setters, then hand it to CachedIndex::with_config. Every setting has a sensible default, so CacheConfig::new() alone is a valid config.

Setting	Default	Meaning
capacity	1024	Max distinct searches cached; 0 disables caching.
ttl	none	Optional per-entry time-to-live; expired results are recomputed.

Examples

use std::time::Duration;

use iqdb_cache::{CacheConfig, CachedIndex};

let config = CacheConfig::new()
    .capacity(4096)
    .ttl(Duration::from_secs(30));

let cached = CachedIndex::with_config(iqdb_cache::doc_stub::stub_index(), config);
assert_eq!(cached.capacity(), 4096);
assert_eq!(cached.ttl(), Some(Duration::from_secs(30)));

Implementations

impl CacheConfig

pub fn new() -> Self

A configuration with the default capacity (1024) and no TTL.

Examples

use iqdb_cache::CacheConfig;

let config = CacheConfig::new();
// Equivalent to `CachedIndex::new(..)`'s defaults.

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

Sets the maximum number of distinct cached searches.

A capacity of 0 disables caching: searches pass straight through.

Examples

use iqdb_cache::CacheConfig;

let config = CacheConfig::new().capacity(256);

pub fn ttl(self, ttl: Duration) -> Self

Sets a per-entry time-to-live: a cached result older than ttl is treated as a miss and recomputed.

TTL bounds staleness from changes the wrapper cannot observe (for example, the wrapped index mutated through another handle). Mutations through the wrapper already invalidate exactly, independent of TTL.

Examples

use std::time::Duration;

use iqdb_cache::CacheConfig;

let config = CacheConfig::new().ttl(Duration::from_secs(60));

pub fn no_ttl(self) -> Self

Clears any previously set TTL, so cached results never expire on time (only on mutation).

Examples

use std::time::Duration;

use iqdb_cache::CacheConfig;

let config = CacheConfig::new().ttl(Duration::from_secs(60)).no_ttl();

Trait Implementations

impl Clone for CacheConfig

fn clone(&self) -> CacheConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CacheConfig

fn default() -> Self

Returns the “default value” for a type.

impl Eq for CacheConfig

impl PartialEq for CacheConfig

fn eq(&self, other: &CacheConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CacheConfig