Skip to main content

CacheConfig

Struct CacheConfig 

Source
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

Source

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

Source

pub const fn storage(&self) -> &StorageLayout

Returns the immutable persistent layout and its disk bound.

Source

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.

Source

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.

Trait Implementations§

Source§

impl Clone for CacheConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CacheConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CacheConfig

Source§

impl PartialEq for CacheConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CacheConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.