redisson 0.1.0

A Redis-based distributed synchronization and data structures library for Rust
Documentation 
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

/*
 *
 *  *
 *  *      Copyright (c) 2018-2025, SnackCloud All rights reserved.
 *  *
 *  *   Redistribution and use in source and binary forms, with or without
 *  *   modification, are permitted provided that the following conditions are met:
 *  *
 *  *   Redistributions of source code must retain the above copyright notice,
 *  *   this list of conditions and the following disclaimer.
 *  *   Redistributions in binary form must reproduce the above copyright
 *  *   notice, this list of conditions and the following disclaimer in the
 *  *   documentation and/or other materials provided with the distribution.
 *  *   Neither the name of the www.snackcloud.cn developer nor the names of its
 *  *   contributors may be used to endorse or promote products derived from
 *  *   this software without specific prior written permission.
 *  *   Author: SnackCloud
 *  *
 *  
 */
mod local;
mod redis;


pub use local::*;
pub use redis::*;

use std::hash::Hash;
use std::sync::Arc;
use std::time::Duration;
use serde::de::DeserializeOwned;
use serde::Serialize;
use crate::{CacheStats, RedissonResult, SyncRedisConnectionManager};

pub trait Cache<K, V> {
    fn get(&self, key: &K) -> RedissonResult<Option<V>>;
    fn set(&self, key: K, value: V) -> RedissonResult<()>;

    fn set_with_ttl(&self, key: K, value: V, ttl: Duration) -> RedissonResult<()>;
    fn remove(&self, key: &K) -> RedissonResult<bool>;
    fn clear(&self) -> RedissonResult<()>;
    fn refresh(&self, key: &K) -> RedissonResult<bool>;
}

/// Cache factory
pub struct CacheFactory {
    connection_manager: Arc<SyncRedisConnectionManager>,
    local_cache_manager: Arc<LocalCacheManager<String, serde_json::Value>>,
}

impl CacheFactory {
    pub fn new(connection_manager: Arc<SyncRedisConnectionManager>) -> Self {
        Self::with_defaults(connection_manager, Duration::from_secs(300), 1000)
    }

    pub fn with_defaults(
        connection_manager: Arc<SyncRedisConnectionManager>,
        default_ttl: Duration,
        default_max_size: usize,
    ) -> Self {
        let local_cache_manager = Arc::new(LocalCacheManager::new(
            default_ttl,
            default_max_size,
        ));

        Self {
            connection_manager,
            local_cache_manager,
        }
    }

    pub fn create_cache<K, V>(
        &self,
        cache_name: &str,
        ttl: Duration,
        max_size: usize,
    ) -> Arc<dyn Cache<K, V>>
    where
        K: Eq + Hash + Clone + Serialize + DeserializeOwned + std::fmt::Debug + Send + Sync + 'static,
        V: Clone + Serialize + DeserializeOwned + Send + Sync + 'static,
    {
        let cache = RedisIntegratedCache::new(
            self.connection_manager.clone(),
            cache_name,
            ttl,
            max_size,
        );

        Arc::new(cache)
    }

    pub fn create_cache_with_options<K, V>(
        &self,
        cache_name: &str,
        ttl: Duration,
        max_size: usize,
        read_through: bool,
        write_through: bool,
        use_local_cache: bool,
    ) -> Arc<dyn Cache<K, V>>
    where
        K: Eq + Hash + Clone + Serialize + DeserializeOwned + std::fmt::Debug + Send + Sync + 'static,
        V: Clone + Serialize + DeserializeOwned + Send + Sync + 'static,
    {
        let cache = RedisIntegratedCache::new(
            self.connection_manager.clone(),
            cache_name,
            ttl,
            max_size,
        )
            .with_read_through(read_through)
            .with_write_through(write_through)
            .with_local_cache(use_local_cache);

        Arc::new(cache)
    }

    pub fn get_local_cache(&self, name: &str) -> Arc<LocalCache<String, serde_json::Value>> {
        self.local_cache_manager.get_or_create_cache(name)
    }

    pub fn get_cache_stats(&self) -> CacheStats {
        self.local_cache_manager.get_stats()
    }
}