Struct DocCacheTtl 

pub struct DocCacheTtl {
    pub crate_docs_secs: u64,
    pub search_results_secs: u64,
    pub item_docs_secs: u64,
    /* private fields */
}

Document cache TTL configuration

Configure independent TTL for different document types.

Fields

• crate_docs_secs: Crate document cache duration (seconds)
• search_results_secs: search results cache duration (seconds)
• item_docs_secs: item docs cache duration (seconds)
• jitter_ratio: TTL jitter ratio(0.0-1.0),used to prevent cache stampede

Fields

crate_docs_secs: u64

Crate document TTL (seconds)

search_results_secs: u64

Search results TTL (seconds)

item_docs_secs: u64

Item documentation TTL (seconds)

Implementations

impl DocCacheTtl

pub fn from_cache_config(config: &CacheConfig) -> Self

Create TTL configuration from CacheConfig

Arguments

• config - cache configuration

Returns

Returns TTL configuration based on config with validated jitter_ratio

pub fn with_jitter( crate_docs_secs: u64, search_results_secs: u64, item_docs_secs: u64, jitter_ratio: f64, ) -> Self

Create TTL configuration with custom jitter ratio

Arguments

• crate_docs_secs - Crate docs TTL in seconds
• search_results_secs - Search results TTL in seconds
• item_docs_secs - Item docs TTL in seconds
• jitter_ratio - Jitter ratio (0.0-1.0), out-of-range values are clamped

Returns

Returns TTL configuration with validated and clamped jitter_ratio

pub const fn jitter_ratio(&self) -> f64

Get the current jitter ratio

pub fn set_jitter_ratio(&mut self, ratio: f64)

Set the jitter ratio with validation

Values outside [0.0, 1.0] range are clamped to the nearest valid value. NaN values are treated as 0.0.

Arguments

• ratio - The jitter ratio to set

Examples

use crates_docs::tools::docs::cache::DocCacheTtl;

let mut ttl = DocCacheTtl::default();
ttl.set_jitter_ratio(0.2);
assert!((ttl.jitter_ratio() - 0.2).abs() < f64::EPSILON);

// Out of range values are clamped
ttl.set_jitter_ratio(1.5);
assert!((ttl.jitter_ratio() - 1.0).abs() < f64::EPSILON);

pub fn apply_jitter(&self, base_ttl: u64) -> u64

Calculate actual TTL with jitter

Arguments

• base_ttl - Base TTL (seconds)

Returns

Returns jittered TTL (seconds)

pub fn crate_docs_duration(&self) -> Duration

Get TTL duration for crate docs with jitter applied

pub fn search_results_duration(&self) -> Duration

Get TTL duration for search results with jitter applied

pub fn item_docs_duration(&self) -> Duration

Get TTL duration for item docs with jitter applied

Trait Implementations

impl Clone for DocCacheTtl

fn clone(&self) -> DocCacheTtl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocCacheTtl

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

Formats the value using the given formatter.

impl Default for DocCacheTtl

fn default() -> Self

Returns the “default value” for a type.

impl Copy for DocCacheTtl