[go: up one dir, main page]

cached 0.2.2

Simple function caching/memoization
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

/*!
Macro(s) for defining functions that wrap a static-ref cache object.

 */

#[macro_export]
/// Creates a function wrapping a cache.
/// There are several options for specifying a cache-type.
/// 1.) Use the default unbounded cache
/// ```rust,ignore
/// cached!{CACHE_NAME >>
/// func_name(arg1: arg1_type, arg2: arg2_type) -> return_type = {
///     <regular function body>
/// }}
///
/// 2.) Use an explicitly specified cache-type, but let the macro instantiate it.
///     The cache-type is expected to have a `new` method that takes no arguments.
/// ```rust,ignore
/// cached!{CACHE_NAME: SpecificCacheType >>
/// func_name(arg1: arg1_type, arg2: arg2_type) -> return_type = {
///     <regular function body>
/// }}
///
/// 3.) Use an explicitly specified cache-type and provide the instantiated cache struct.
///     This would allow using caches that require args in their constructor or has a constructor
///     method other than a simple `new`.
/// ```rust,ignore
/// cached!{CACHE_NAME: MyCache = MyCache::with_capacity(arg); >>
/// func_name(arg1: arg1_type, arg2: arg2_type) -> return_type = {
///     <regular function body>
/// }}
/// ```
macro_rules! cached {
    // Use default cached::Cache
    ($cachename:ident >> $name:ident ($($arg:ident : $argtype:ty),*) -> $ret:ty = $body:expr) => {
        lazy_static! {
            static ref $cachename: ::std::sync::Mutex<cached::Cache<($($argtype),*), $ret>> = {
                ::std::sync::Mutex::new(cached::Cache::new())
            };
        }
        #[allow(unused_parens)]
        pub fn $name($($arg: $argtype),*) -> $ret {
            let key = ($($arg.clone()),*);
            {
                let mut cache = $cachename.lock().unwrap();
                let res = cache.cache_get(&key);
                if let Some(res) = res { return res.clone(); }
            }
            let val = (||$body)();
            let mut cache = $cachename.lock().unwrap();
            cache.cache_set(key, val.clone());
            val
        }
    };

    // Use specified cache-type, implicitly create the cache (expect there to be a `new` method)
    ($cachename:ident : $cachetype:ident >> $name:ident ($($arg:ident : $argtype:ty),*) -> $ret:ty = $body:expr) => {
        lazy_static! {
            static ref $cachename: ::std::sync::Mutex<$cachetype<($($argtype),*), $ret>> = {
                ::std::sync::Mutex::new($cachetype::new())
            };
        }
        #[allow(unused_parens)]
        pub fn $name($($arg: $argtype),*) -> $ret {
            let key = ($($arg.clone()),*);
            {
                let mut cache = $cachename.lock().unwrap();
                cached::enforce_cached_impl(&cache);
                let res = cache.cache_get(&key);
                if let Some(res) = res { return res.clone(); }
            }
            let val = (||$body)();
            let mut cache = $cachename.lock().unwrap();
            cache.cache_set(key, val.clone());
            val
        }
    };

    // Use a specified cache-type and an explicitly created cache-instance
    ($cachename:ident : $cachetype:ident = $cacheinstance:expr ; >> $name:ident ($($arg:ident : $argtype:ty),*) -> $ret:ty = $body:expr) => {
        lazy_static! {
            static ref $cachename: ::std::sync::Mutex<$cachetype<($($argtype),*), $ret>> = {
                ::std::sync::Mutex::new($cacheinstance)
            };
        }
        #[allow(unused_parens)]
        pub fn $name($($arg: $argtype),*) -> $ret {
            let key = ($($arg.clone()),*);
            {
                let mut cache = $cachename.lock().unwrap();
                cached::enforce_cached_impl(&cache);
                let res = cache.cache_get(&key);
                if let Some(res) = res { return res.clone(); }
            }
            let val = (||$body)();
            let mut cache = $cachename.lock().unwrap();
            cache.cache_set(key, val.clone());
            val
        }
    };
}