oxcache 0.2.0

A high-performance multi-level cache library for Rust with L1 (memory) and L2 (Redis) caching.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

//! Copyright (c) 2025-2026, Kirky.X
//!
//! MIT License
//!
//! 工具模块
//!
//! 提供缓存键生成器等工具函数。

pub mod key_generator;
pub use key_generator::KeyGenerator;

use crate::error::CacheError;

const MAX_CACHE_KEY_LENGTH: usize = 1024;
const VALID_KEY_CHARS: &[char] = &[
    'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
    'x', 'y', 'z', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T',
    'U', 'V', 'W', 'X', 'Y', 'Z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '-', '_', '.', ':', '/', '@',
];

pub fn validate_cache_key(key: &str) -> Result<(), CacheError> {
    if key.is_empty() {
        return Err(CacheError::InvalidInput("Cache key cannot be empty".to_string()));
    }

    if key.len() > MAX_CACHE_KEY_LENGTH {
        return Err(CacheError::InvalidInput(format!(
            "Cache key exceeds maximum length of {} bytes (got {} bytes)",
            MAX_CACHE_KEY_LENGTH,
            key.len()
        )));
    }

    for c in key.chars() {
        if !VALID_KEY_CHARS.contains(&c) {
            return Err(CacheError::InvalidInput(format!(
                "Cache key contains invalid character '{}'. Valid characters are: alphanumeric and -_.:/@",
                c
            )));
        }
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_validate_cache_key_valid() {
        assert!(validate_cache_key("user:123").is_ok());
        assert!(validate_cache_key("cache/item").is_ok());
        assert!(validate_cache_key("session@abc").is_ok());
        assert!(validate_cache_key("a.b-c_d").is_ok());
        assert!(validate_cache_key("namespace:key:path").is_ok());
    }

    #[test]
    fn test_validate_cache_key_empty() {
        let result = validate_cache_key("");
        assert!(result.is_err());
        match result.unwrap_err() {
            CacheError::InvalidInput(msg) => assert!(msg.contains("cannot be empty")),
            _ => panic!("Expected InvalidInput error"),
        }
    }

    #[test]
    fn test_validate_cache_key_too_long() {
        // MAX_CACHE_KEY_LENGTH is 1024
        let long_key = "a".repeat(MAX_CACHE_KEY_LENGTH + 1);
        let result = validate_cache_key(&long_key);
        assert!(result.is_err());
        match result.unwrap_err() {
            CacheError::InvalidInput(msg) => assert!(msg.contains("maximum length")),
            _ => panic!("Expected InvalidInput error"),
        }
    }

    #[test]
    fn test_validate_cache_key_exactly_max_length() {
        let key = "a".repeat(MAX_CACHE_KEY_LENGTH);
        assert!(validate_cache_key(&key).is_ok());
    }

    #[test]
    fn test_validate_cache_key_invalid_chars() {
        // Space
        assert!(validate_cache_key("key with space").is_err());
        // Null byte
        assert!(validate_cache_key("key\0null").is_err());
        // Newline
        assert!(validate_cache_key("key\nnewline").is_err());
        // Tab
        assert!(validate_cache_key("key\ttab").is_err());
        // Special chars
        assert!(validate_cache_key("key#hash").is_err());
        assert!(validate_cache_key("key$dollar").is_err());
        assert!(validate_cache_key("key%percent").is_err());
    }

    #[test]
    fn test_validate_cache_key_all_valid_chars() {
        // Test all characters in VALID_KEY_CHARS
        let key: String = VALID_KEY_CHARS.iter().collect();
        assert!(validate_cache_key(&key).is_ok());
    }
}