Expand description
Bounded RAM + Region SSD cache.
Mutations provide process-local visibility. An unclean restart opens empty;
Cache::close_warm publishes a recoverable image.
See Error for failure classifications and handling policy.
Structs§
- Cache
- An open cache bound to one Tokio runtime.
- Cache
Config - Complete, immutable configuration for opening a
Cache. - Cache
Index Snapshot - Current L2 index occupancy and cumulative mutation diagnostics.
- Cache
IoDirection Snapshot - Cumulative engine-request and runtime-file-I/O statistics for one direction.
- Cache
IoPath Snapshot - Cumulative runtime file activity for one I/O path.
- Cache
IoSnapshot - Cumulative I/O statistics split by direction.
- Cache
L1Snapshot - Current L1 occupancy and fixed metadata footprint.
- Cache
Reclaim Snapshot - Cumulative work performed by Region reclamation.
- Cache
Snapshot - Point-in-time operational counters and cache-owned resource accounting.
- Cache
Stats Snapshot - Cumulative monitoring snapshot without metadata scans.
- Detailed
Cache Snapshot - On-demand operational detail across all cache tiers.
- Error
- Structured failure returned by a public C² operation.
- Fill
Control Snapshot - Fill-pressure controller state and accounting.
- Fill
Limits - Logical fill-rate ceilings shared by
FillControlOptions::ObserveandFillControlOptions::Adaptive. - IoLatency
Snapshot - Fully observed engine durations for one role/result combination.
- IoUring
Options - Pool topology for the experimental
io_uringengine’s independent read, write, and reclaim pools. - IoUring
Pool Options - Ring count and aggregate execution bound for one pool of the experimental
io_uringengine. - IoUring
SqPoll Options - Kernel submission-queue polling parameters for the experimental
io_uringengine. - Latency
Snapshot - Cumulative observations for one population since open.
- Posix
IoOptions - Worker topology for POSIX positioned I/O.
- Region
Snapshot - Current Region-store geometry, queue membership, and physical occupancy.
- Request
Stats Snapshot - One allowed public-operation/result combination.
- Runtime
Options - Process-local runtime configuration checked together by
CacheConfig::new. - Stats
Options - Statistics collection selected once per open.
- Storage
Layout - Immutable persistent geometry with a checked logical disk bound.
- Storage
Options - Inputs for a persistent L2 layout, checked by
Self::build. - Value
- Owned cache value returned by
Cache::get.
Enums§
- Cache
Health - Current availability of the cache instance.
- Cache
Tier - Storage tier that served a lookup.
- Error
Kind - Stable, actionable classification for a C² failure.
- Error
Operation - Public operation during which a C² failure occurred.
- Fill
Control Options - Optional pre-timeout pressure observation and fill admission control.
- Fill
Pressure - Admission pressure, independent of terminal cache health.
- IoEngine
Options - Engine selection and topology for the independent read, write, and reclaim
I/O pools, validated by
CacheConfig::new. - IoMode
- Buffered/direct policy for runtime cache-record I/O.
- IoOutcome
- Terminal engine result, distinct from caller cancellation or timeout.
- IoRole
- Engine ownership, independent of buffered/direct file-operation accounting.
- L1Eviction
Policy - Eviction policy for the process-local L1 tier.
- Latency
Mode - Duration collection for one timing scope, selected before its outcome is known.
- Read
Admission - Admission after an L2 index candidate has been selected.
- Request
Latency Scope - Interval measured by a request duration distribution.
- Request
Operation - Public operation whose terminal outcome is recorded.
- Request
Outcome - Mutually exclusive terminal result; internal events may overlap these counts.
- Startup
Mode - How the current cache instance obtained its initial state.
Constants§
- LATENCY_
BUCKET_ UPPER_ BOUNDS_ NS - Explicit duration bucket upper bounds in nanoseconds, inclusive.