dynomite-engine 0.0.1

Embeddable Dynamo-style distributed replication engine: token-ring partitioning, gossip cluster, hinted handoff, anti-entropy, RediSearch FT.* surface.
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

//! Memcached command classification helpers.
//!
//! Each predicate mirrors a categorical check in the reference
//! engine's command dispatch (storage / retrieval / arithmetic /
//! delete / touch / cas) and is reused by the parser, fragmenter,
//! and verifier.

use crate::msg::MsgType;

/// True when `ty` denotes a Memcached storage command (`set`,
/// `add`, `replace`, `append`, `prepend`, `cas`).
///
/// # Examples
///
/// ```
/// use dynomite::msg::MsgType;
/// use dynomite::proto::memcache::memcache_storage;
/// assert!(memcache_storage(MsgType::ReqMcSet));
/// assert!(memcache_storage(MsgType::ReqMcCas));
/// assert!(!memcache_storage(MsgType::ReqMcGet));
/// ```
#[must_use]
pub fn memcache_storage(ty: MsgType) -> bool {
    matches!(
        ty,
        MsgType::ReqMcSet
            | MsgType::ReqMcCas
            | MsgType::ReqMcAdd
            | MsgType::ReqMcReplace
            | MsgType::ReqMcAppend
            | MsgType::ReqMcPrepend
    )
}

/// True when `ty` is the Memcached `cas` command.
///
/// # Examples
///
/// ```
/// use dynomite::msg::MsgType;
/// use dynomite::proto::memcache::memcache_cas;
/// assert!(memcache_cas(MsgType::ReqMcCas));
/// assert!(!memcache_cas(MsgType::ReqMcSet));
/// ```
#[must_use]
pub fn memcache_cas(ty: MsgType) -> bool {
    matches!(ty, MsgType::ReqMcCas)
}

/// True when `ty` denotes a Memcached retrieval command (`get`,
/// `gets`).
///
/// # Examples
///
/// ```
/// use dynomite::msg::MsgType;
/// use dynomite::proto::memcache::memcache_retrieval;
/// assert!(memcache_retrieval(MsgType::ReqMcGet));
/// assert!(memcache_retrieval(MsgType::ReqMcGets));
/// assert!(!memcache_retrieval(MsgType::ReqMcSet));
/// ```
#[must_use]
pub fn memcache_retrieval(ty: MsgType) -> bool {
    matches!(ty, MsgType::ReqMcGet | MsgType::ReqMcGets)
}

/// True when `ty` denotes a Memcached arithmetic command (`incr`,
/// `decr`).
///
/// # Examples
///
/// ```
/// use dynomite::msg::MsgType;
/// use dynomite::proto::memcache::memcache_arithmetic;
/// assert!(memcache_arithmetic(MsgType::ReqMcIncr));
/// assert!(memcache_arithmetic(MsgType::ReqMcDecr));
/// ```
#[must_use]
pub fn memcache_arithmetic(ty: MsgType) -> bool {
    matches!(ty, MsgType::ReqMcIncr | MsgType::ReqMcDecr)
}

/// True when `ty` is the Memcached `delete` command.
///
/// # Examples
///
/// ```
/// use dynomite::msg::MsgType;
/// use dynomite::proto::memcache::memcache_delete;
/// assert!(memcache_delete(MsgType::ReqMcDelete));
/// ```
#[must_use]
pub fn memcache_delete(ty: MsgType) -> bool {
    matches!(ty, MsgType::ReqMcDelete)
}

/// True when `ty` is the Memcached `touch` command.
///
/// # Examples
///
/// ```
/// use dynomite::msg::MsgType;
/// use dynomite::proto::memcache::memcache_touch;
/// assert!(memcache_touch(MsgType::ReqMcTouch));
/// ```
#[must_use]
pub fn memcache_touch(ty: MsgType) -> bool {
    matches!(ty, MsgType::ReqMcTouch)
}

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

    #[test]
    fn classification_partition_is_disjoint() {
        for ty in [
            MsgType::ReqMcGet,
            MsgType::ReqMcGets,
            MsgType::ReqMcSet,
            MsgType::ReqMcAdd,
            MsgType::ReqMcReplace,
            MsgType::ReqMcAppend,
            MsgType::ReqMcPrepend,
            MsgType::ReqMcCas,
            MsgType::ReqMcDelete,
            MsgType::ReqMcIncr,
            MsgType::ReqMcDecr,
            MsgType::ReqMcTouch,
            MsgType::ReqMcQuit,
        ] {
            let storage = memcache_storage(ty);
            let retrieval = memcache_retrieval(ty);
            let arithmetic = memcache_arithmetic(ty);
            let delete = memcache_delete(ty);
            let touch = memcache_touch(ty);
            // Every command is at most in one of these categories.
            let count = [storage, retrieval, arithmetic, delete, touch]
                .iter()
                .filter(|x| **x)
                .count();
            assert!(count <= 1, "{ty:?} matched {count} categories");
        }
    }
}