txmap 3.0.1

A concurrent transactional hash map for Rust with fine-grained locking, internal mutability and composable transactions
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182

use crate::{indexer::Indexer, key::TxKey, shard::Shard};
use std::hash::{BuildHasher, Hash};

pub(crate) struct ShardOps;

impl ShardOps {
    #[inline]
    pub fn value_ref<'op, K, V>(shard: &'op Shard<K, V>, key: &TxKey<K>) -> Option<&'op V>
    where
        K: Clone + Hash + Eq,
    {
        shard
            .find(key.hash_code.0, |entry| entry.0 == key.key)
            .map(|(_key, value)| value)
    }

    #[inline]
    pub fn insert<K, V, S>(
        shard: &mut Shard<K, V>,
        key: &TxKey<K>,
        value: V,
        indexer: &Indexer<S>,
    ) -> Option<V>
    where
        K: Clone + Hash + Eq,
        S: BuildHasher,
    {
        let entry = shard.entry(
            key.hash_code.0,
            |entry| entry.0 == key.key,
            |entry| indexer.hash(&entry.0).0,
        );
        match entry {
            hashbrown::hash_table::Entry::Occupied(occupied) => {
                let ((old_key, old_value), vacant) = occupied.remove();
                vacant.insert((old_key, value));
                Some(old_value)
            }
            hashbrown::hash_table::Entry::Vacant(vacant) => {
                vacant.insert((key.key.clone(), value));
                None
            }
        }
    }

    #[inline]
    pub fn insert_if_absent<K, V, S>(
        shard: &mut Shard<K, V>,
        key: &TxKey<K>,
        value_gen: impl FnOnce() -> V,
        indexer: &Indexer<S>,
    ) -> bool
    where
        K: Clone + Hash + Eq,
        S: BuildHasher,
    {
        let entry = shard.entry(
            key.hash_code.0,
            |entry| entry.0 == key.key,
            |entry| indexer.hash(&entry.0).0,
        );
        match entry {
            hashbrown::hash_table::Entry::Occupied(_) => false,
            hashbrown::hash_table::Entry::Vacant(vacant) => {
                vacant.insert((key.key.clone(), value_gen()));
                true
            }
        }
    }

    #[inline]
    pub fn insert_with_duplicate_key<K, V, S>(
        shard: &mut Shard<K, V>,
        key: &TxKey<K>,
        duplicate_key: K,
        value: V,
        indexer: &Indexer<S>,
    ) where
        K: Hash + Eq,
        S: BuildHasher,
    {
        shard
            .entry(
                key.hash_code.0,
                |entry| entry.0 == key.key,
                |entry| indexer.hash(&entry.0).0,
            )
            .insert((duplicate_key, value));
    }

    #[inline]
    pub fn modify<K, V>(
        shard: &mut Shard<K, V>,
        key: &TxKey<K>,
        mutate: impl FnOnce(&K, &mut V),
    ) -> bool
    where
        K: Hash + Eq,
    {
        if let Some(mut_entry) = shard.find_mut(key.hash_code.0, |entry| entry.0 == key.key) {
            mutate(&mut_entry.0, &mut mut_entry.1);
            true
        } else {
            false
        }
    }

    #[inline]
    pub fn remove_entry<K, V>(shard: &mut Shard<K, V>, key: &TxKey<K>) -> Option<(K, V)>
    where
        K: Hash + Eq,
    {
        shard
            .find_entry(key.hash_code.0, |entry| entry.0 == key.key)
            .ok()
            .map(|entry| entry.remove().0)
    }

    #[inline]
    pub fn remove_if<K, V, S>(
        shard: &mut Shard<K, V>,
        key: &TxKey<K>,
        condition: impl FnOnce(&K, &V) -> bool,
        indexer: &Indexer<S>,
    ) -> Option<V>
    where
        K: Hash + Eq,
        S: BuildHasher,
    {
        let entry = shard.entry(
            key.hash_code.0,
            |entry| entry.0 == key.key,
            |entry| indexer.hash(&entry.0).0,
        );
        match entry {
            hashbrown::hash_table::Entry::Occupied(occupied) => {
                let (found_key, found_value) = occupied.get();
                if condition(found_key, found_value) {
                    Some(occupied.remove().0.1)
                } else {
                    None
                }
            }
            hashbrown::hash_table::Entry::Vacant(_) => None,
        }
    }

    #[inline]
    pub fn update<K, V, S>(
        shard: &mut Shard<K, V>,
        key: &TxKey<K>,
        transform: impl FnOnce(&K, Option<&V>) -> Option<V>,
        indexer: &Indexer<S>,
    ) where
        K: Clone + Hash + Eq,
        S: BuildHasher,
    {
        let entry = shard.entry(
            key.hash_code.0,
            |entry| entry.0 == key.key,
            |entry| indexer.hash(&entry.0).0,
        );
        match entry {
            hashbrown::hash_table::Entry::Occupied(occupied) => {
                let (found_key, found_value) = occupied.get();
                match transform(found_key, Some(found_value)) {
                    Some(new_value) => {
                        occupied.replace_entry_with(|entry| Some((entry.0, new_value)));
                    }
                    None => {
                        occupied.remove();
                    }
                }
            }
            hashbrown::hash_table::Entry::Vacant(vacant) => {
                if let Some(new_value) = transform(&key.key, None) {
                    vacant.insert((key.key.clone(), new_value));
                }
            }
        }
    }
}