oxigeo_cache_advanced/
lib.rs1#![warn(missing_docs)]
12#![deny(unsafe_code)]
13
14pub mod analytics;
15pub mod coherency;
16pub mod compression;
17pub mod distributed;
18pub mod error;
19pub mod eviction;
20pub mod multi_tier;
21pub mod observability;
22pub mod partitioning;
23pub mod predictive;
24pub mod tiering;
25pub mod warming;
26pub mod write_policy;
27
28pub use error::{CacheError, Result};
29pub use eviction::{
30 CountMinSketch, EvictionPolicy, EvictionPolicyType, EvictionStats, WTinyLfuEviction,
31};
32pub use multi_tier::{CacheKey, CacheTier, CacheValue, MultiTierCache};
33
34#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
36pub struct CacheStats {
37 pub hits: u64,
39 pub misses: u64,
41 pub evictions: u64,
43 pub bytes_stored: u64,
45 pub item_count: usize,
47}
48
49impl CacheStats {
50 pub fn new() -> Self {
52 Self {
53 hits: 0,
54 misses: 0,
55 evictions: 0,
56 bytes_stored: 0,
57 item_count: 0,
58 }
59 }
60
61 pub fn hit_rate(&self) -> f64 {
63 if self.hits + self.misses == 0 {
64 0.0
65 } else {
66 (self.hits as f64) / ((self.hits + self.misses) as f64) * 100.0
67 }
68 }
69
70 pub fn avg_item_size(&self) -> f64 {
72 if self.item_count == 0 {
73 0.0
74 } else {
75 (self.bytes_stored as f64) / (self.item_count as f64)
76 }
77 }
78}
79
80impl Default for CacheStats {
81 fn default() -> Self {
82 Self::new()
83 }
84}
85
86#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
88pub struct CacheConfig {
89 pub l1_size: usize,
91 pub l2_size: usize,
93 pub l3_size: usize,
95 pub enable_compression: bool,
97 pub enable_prefetch: bool,
99 pub enable_distributed: bool,
101 pub cache_dir: Option<std::path::PathBuf>,
103 #[serde(default)]
109 pub eviction_policy: EvictionPolicyType,
110}
111
112impl Default for CacheConfig {
113 fn default() -> Self {
114 Self {
115 l1_size: 128 * 1024 * 1024, l2_size: 1024 * 1024 * 1024, l3_size: 10 * 1024 * 1024 * 1024, enable_compression: true,
119 enable_prefetch: true,
120 enable_distributed: false,
121 cache_dir: None,
122 eviction_policy: EvictionPolicyType::Lru,
123 }
124 }
125}
126
127#[cfg(test)]
128mod tests {
129 use super::*;
130
131 #[test]
132 fn test_cache_stats_hit_rate() {
133 let mut stats = CacheStats::new();
134 stats.hits = 80;
135 stats.misses = 20;
136
137 approx::assert_relative_eq!(stats.hit_rate(), 80.0, epsilon = 0.01);
138 }
139
140 #[test]
141 fn test_cache_stats_avg_size() {
142 let mut stats = CacheStats::new();
143 stats.bytes_stored = 1000;
144 stats.item_count = 10;
145
146 approx::assert_relative_eq!(stats.avg_item_size(), 100.0, epsilon = 0.01);
147 }
148
149 #[test]
150 fn test_default_config() {
151 let config = CacheConfig::default();
152 assert!(config.enable_compression);
153 assert!(config.enable_prefetch);
154 assert!(!config.enable_distributed);
155 }
156}