Struct CacheService 

pub struct CacheService { /* private fields */ }

The orbok cache service. One per data directory.

Implementations

impl CacheService

pub fn new(data_dir: &Path) -> Self

Create the service for a data directory; the payload database is <data_dir>/orbok-cache.sqlite3 (Appendix A §3).

pub fn db_path(&self) -> &Path

Payload database path (storage dashboard).

pub fn engine<T: Serialize + DeserializeOwned>( &self, catalog: &Catalog, namespace: &OrbokCacheNamespace, options: EngineOptions, ) -> OrbokResult<CacheEngine<T>>

Open a typed engine for namespace, registering it in the catalog cache_engines table. Change detection is metadata-then-full-hash (Appendix A §8: metadata fast path with hash confirmation, mirroring the scanner’s policy).

pub fn get_fresh<T: Serialize + DeserializeOwned>( engine: &CacheEngine<T>, path: &ValidatedPath, ) -> OrbokResult<Option<T>>

Freshness-checked read: returns the payload only when localcache confirms the source file is unchanged (Appendix A §8). The catalog/scanner remains the authority for file state.

pub fn put<T: Serialize + DeserializeOwned>( engine: &CacheEngine<T>, path: &ValidatedPath, payload: &T, ) -> OrbokResult<()>

Store a derived payload for a boundary-validated source path.

pub fn remove<T: Serialize + DeserializeOwned>( engine: &CacheEngine<T>, path: &ValidatedPath, ) -> OrbokResult<bool>

Invalidate one entry (e.g. file deleted from catalog).

pub fn run_safe_cleanup( &self, catalog: &Catalog, plan: &CleanupPlan, ) -> OrbokResult<CacheCleanupOutcome>

Safe cleanup driven by a validated plan (RFC-001 §9, Appendix A §12). Maps each action to its payload namespaces and runs expiry + missing-file + stale-version maintenance there.

pub fn shrink(&self, catalog: &Catalog) -> OrbokResult<()>

Reclaim file space after large deletions (storage dashboard’s explicit “shrink” action; Appendix A §12).

pub fn usage( &self, catalog: &Catalog, namespaces: &[OrbokCacheNamespace], ) -> OrbokResult<Vec<NamespaceUsage>>

Usage per namespace for storage accounting (Appendix A §11).