dualcache-ff 0.2.3

A wait-free, high-performance concurrent cache optimized for extreme read-to-write ratios.
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

use core::marker::PhantomData;

/// A zero-overhead, completely compiled-away stub implementation of the DualCache API.
/// All methods are marked with `#[inline(always)]` and evaluate to no-ops.
/// Suitable for ultra-constrained bare-metal environments where caching is compiled out.
#[derive(Debug, Clone)]
pub struct DualCacheStub<K, V> {
    _marker: PhantomData<(K, V)>,
}

impl<K, V> DualCacheStub<K, V> {
    /// Create a new stub cache instance (which does nothing).
    #[inline(always)]
    pub fn new(_config: crate::Config) -> Self {
        Self {
            _marker: PhantomData,
        }
    }

    /// Exposes API parity with `DualCacheFF::new_headless`
    #[inline(always)]
    pub fn new_headless(_config: crate::Config) -> (Self, ()) {
        (
            Self {
                _marker: PhantomData,
            },
            (),
        )
    }

    /// Exposes API parity with `DualCacheFF::get`
    #[inline(always)]
    pub fn get(&self, _key: &K) -> Option<V> {
        None
    }

    /// Exposes API parity with `DualCacheFF::insert`
    #[inline(always)]
    pub fn insert(&self, _key: K, _value: V) {}

    /// Exposes API parity with `DualCacheFF::remove`
    #[inline(always)]
    pub fn remove(&self, _key: &K) {}

    /// Exposes API parity with `DualCacheFF::clear`
    #[inline(always)]
    pub fn clear(&self) {}

    /// Exposes API parity with `DualCacheFF::sync`
    #[inline(always)]
    pub fn sync(&self) {}
}