Struct DialCacheBuilder 

pub struct DialCacheBuilder { /* private fields */ }

Configures a DialCache.

Implementations

impl DialCacheBuilder

pub fn namespace(self, namespace: impl Into<String>) -> Self

Logical namespace used in keys, invalidation identity, cohorts and labels. Defaults to "urn"; may not contain { or }.

pub fn remote(self, remote: impl Remote) -> Self

The remote layer adapter. Without one, only request and local layers serve.

pub fn remote_arc(self, remote: Arc<dyn Remote>) -> Self

The remote layer adapter, shared.

pub fn observer(self, observer: impl Observer) -> Self

Receives every public diagnostic; also the shadow outcome hook.

pub fn observer_arc(self, observer: Arc<dyn Observer>) -> Self

Receives every public diagnostic, shared.

pub fn logger(self, logger: impl Logger) -> Self

Receives structured log events. Defaults to the log crate facade under target dialcache.

pub fn logger_arc(self, logger: Arc<dyn Logger>) -> Self

Receives structured log events, shared.

pub fn policy_provider<F, Fut>(self, provider: F) -> Self

where F: Fn(Identity) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Option<RuntimePolicy>, BoxError>> + Send + 'static,

Runtime policy overlay resolved once per enabled call. Ok(None) inherits the operation policy; an error bypasses caching for that call.

pub fn local_capacity(self, capacity: usize) -> Self

Maximum process-local entries across every use case. Zero disables local storage while preserving coalescing. Defaults to 10,000.

pub fn local_store(self, store: Box<dyn LocalStore>) -> Self

Replace the default LRU store. Advanced: the store must preserve the documented LRU, expiry and promotion rules.

pub fn remote_read_timeout_ms(self, ms: u64) -> Self

Instance default remote read budget. Defaults to 50 ms.

pub fn shadow_max_in_flight(self, jobs: usize) -> Self

Concurrent shadow jobs per instance; excess work is dropped. Defaults to 1.

pub fn should_recover( self, predicate: impl Fn(&Error) -> bool + Send + Sync + 'static, ) -> Self

Instance default classifier deciding whether a source failure may use a retained stale value. Omission admits only the source deadline error.

pub fn compression(self, config: CompressionConfig) -> Self

Write-side compression policy. Enabled by default at a 4,096-byte threshold.

pub fn disable_compression(self) -> Self

Store every payload uncompressed. Reads still accept compressed entries.

pub fn clock(self, clock: impl Clock) -> Self

Replace the wall and elapsed clock. Defaults to SystemClock.

pub fn clock_arc(self, clock: Arc<dyn Clock>) -> Self

Share a clock between instances (for example a controlled test clock).

pub fn runtime_arc(self, runtime: Arc<dyn Runtime>) -> Self

Share a runtime between instances.

pub fn runtime(self, runtime: impl Runtime) -> Self

Replace the executor and timer source. Defaults to tokio.

pub fn build(self) -> Result<DialCache, ConfigError>

Validate the configuration and create the instance. Rejects a namespace containing { or }, a read budget outside 1..=2_147_483_647 ms, a zero shadow cap, an invalid compression config, or no usable runtime: with the tokio feature, no tokio runtime is current and none was supplied through runtime or runtime_arc; without it, no runtime was supplied.

Trait Implementations

impl Debug for DialCacheBuilder

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

Formats the value using the given formatter.