pub struct CacheConfig { /* private fields */ }Expand description
Complete, immutable configuration for opening a Cache.
Construction checks runtime settings against the storage layout and managed memory limit. It performs bounded calculations without opening files, starting workers, or requiring Tokio. Resource queries reuse the computed results. Clone a configuration to reuse it across paths or successive opens; each open acquires its own resources and can still fail on I/O or allocation.
Implementations§
Source§impl CacheConfig
impl CacheConfig
Sourcepub fn new(
storage: StorageLayout,
runtime: RuntimeOptions,
) -> Result<Self, Error>
pub fn new( storage: StorageLayout, runtime: RuntimeOptions, ) -> Result<Self, Error>
Checks the complete combination and resolves dependent runtime defaults.
§Errors
Returns ErrorOperation::BuildConfig for incompatible Region/shard
counts, invalid runtime settings, unavailable build/platform features,
or insufficient managed memory. Device capabilities are checked at open.
§Examples
use cache2::Cache;
use cache2::CacheConfig;
use cache2::IoEngineOptions;
use cache2::PosixIoOptions;
use cache2::RuntimeOptions;
use cache2::StorageOptions;
let mut storage = StorageOptions::new(1024 * 1024 * 1024);
storage.expected_entries = Some(100_000);
let storage = storage.build()?;
let mut io = PosixIoOptions::default();
io.read_workers = 8;
let mut runtime = RuntimeOptions::default();
runtime.io_engine = IoEngineOptions::Posix(io);
runtime.stats.activity_counters = true;
let config = CacheConfig::new(storage, runtime)?;
let disk_peak = config.storage().peak_disk_bytes();
let memory_floor = config.minimum_memory_bytes();
let cache = Cache::open("cache.data", config).await?;Source§impl CacheConfig
impl CacheConfig
Sourcepub const fn storage(&self) -> &StorageLayout
pub const fn storage(&self) -> &StorageLayout
Returns the immutable persistent layout and its disk bound.
Sourcepub const fn runtime(&self) -> &RuntimeOptions
pub const fn runtime(&self) -> &RuntimeOptions
Returns the selected runtime options with dependent defaults resolved.
Clone these inputs to derive a new configuration with adjusted tuning.
When ReadAdmission::Wait was configured
with max_waiters: None, this accessor returns the resolved Some(...)
count, so reset max_waiters to None before changing read concurrency
if you want it recomputed automatically.
Sourcepub const fn minimum_memory_bytes(&self) -> usize
pub const fn minimum_memory_bytes(&self) -> usize
Returns the minimum managed-memory budget required by this configuration.
Includes metadata, L1 capacity, workers, queues, append/reclaim buffers, and one Region-sized read allowance. Concurrent reads and retained values need additional headroom. This is not an RSS bound.