Struct DiskOffloadRepository 

pub struct DiskOffloadRepository { /* private fields */ }

CacheRepository decorator that offloads entry payloads to disk.

Wraps any index backend; see the module docs for the blob lifecycle and failure policy. stale_retention, sweep_interval, and payload_max_ttl must be non-zero (the payload intervals at least one second — the death epoch truncates to whole seconds) — enforced by CacheRepoConfig validation, not here.

Implementations

impl DiskOffloadRepository

pub fn new( inner: Arc<dyn CacheRepository>, dir: PathBuf, stale_retention: Duration, sweep_interval: Duration, payload_max_ttl: Duration, shutdown_token: CancellationToken, ) -> Self

Wrap inner with disk payload offload into dir (production clock).

The shutdown_token stops the background payload sweeper; it is owned by the sweeper task and never cancelled by the decorator.

pub fn with_clock( inner: Arc<dyn CacheRepository>, dir: PathBuf, stale_retention: Duration, sweep_interval: Duration, payload_max_ttl: Duration, shutdown_token: CancellationToken, clock: OffloadClock, ) -> Self

Test seam: Self::new with an injected OffloadClock.

The injected clock drives death-epoch math only; the spawned sweeper always sweeps on the real clock.

Trait Implementations

impl CacheRepository for DiskOffloadRepository

fn invalidate<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delegate-only: the index row is dropped here; the payload blob becomes an orphan reclaimed asynchronously at its filename-encoded death epoch.

fn clear<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Reclaim payload space now: best-effort unlink of every entry of the payload dir, then delegate to the index. Unlink failures never turn clear into Err — each failure WARNs and the rest of the dir is still attempted.

fn invalidate_prefix<'life0, 'life1, 'async_trait>( &'life0 self, prefix: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<u64, CamelError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delegate-only: the returned count is index-scoped; payload blobs are reclaimed asynchronously at their filename-encoded death epoch.

fn name(&self) -> &str

A human-readable name for this cache backend.

fn get<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<CacheEntry>, CamelError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieve a value by key.

fn set<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, entry: CacheEntry, ttl: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Store a value with an optional TTL.

fn peek_stale<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<CacheEntry>, CamelError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Peek at a stale (expired but not yet evicted) entry.

fn stats<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = CacheStats> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Return current cache statistics. Asynchronous so backends can offload I/O-bound byte accounting off the tokio worker (bd rc-22wj). Default implementation returns zeroed stats.

impl Debug for DiskOffloadRepository

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

Formats the value using the given formatter.

impl Drop for DiskOffloadRepository

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.