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

use crate::{
    indexer::Indexer, key::TxKey, lock_guards::LockGuards, lock_policies::lock_policy::LockPolicy,
    multi_shard_ops::MultiShardOps, new_types::BitMask, shard_ops::ShardOps,
};
use std::{
    hash::{BuildHasher, Hash},
    ops::{Deref, DerefMut},
};

#[allow(clippy::type_complexity)]
pub(crate) enum ImmediateOp<'tx, K, V, STATE>
where
    K: Hash + Eq,
{
    Get {
        key: TxKey<K>,
        get: Box<dyn Fn(&K, Option<&V>, &mut STATE) + 'tx>,
    },
    InsertWith {
        key: TxKey<K>,
        value_generator: Box<dyn Fn(&K, &mut STATE) -> V + 'tx>,
    },
    InsertWithIfAbsent {
        key: TxKey<K>,
        value_generator: Box<dyn Fn(&K, &mut STATE) -> V + 'tx>,
    },
    Modify {
        key: TxKey<K>,
        mutate: Box<dyn Fn(&K, &mut V, &mut STATE) + 'tx>,
    },
    MoveValue {
        key_from: TxKey<K>,
        key_to: TxKey<K>,
    },
    Remove {
        key: TxKey<K>,
    },
    RemoveIf {
        key: TxKey<K>,
        condition: Box<dyn Fn(&K, &V, &mut STATE) -> bool + 'tx>,
    },
    SwapValue {
        key_a: TxKey<K>,
        key_b: TxKey<K>,
    },
    Update {
        key: TxKey<K>,
        transform: Box<dyn Fn(&K, Option<&V>, &mut STATE) -> Option<V> + 'tx>,
    },
}

impl<'tx, K, V, STATE> ImmediateOp<'tx, K, V, STATE>
where
    K: Clone + Hash + Eq,
{
    pub fn read_write_bitmasks(&self) -> (BitMask, BitMask) {
        match self {
            Self::Get { key, .. } => (key.shard_index.bitmask(), BitMask::ZERO),
            Self::InsertWith { key, .. }
            | Self::InsertWithIfAbsent { key, .. }
            | Self::Modify { key, .. }
            | Self::Remove { key, .. }
            | Self::RemoveIf { key, .. }
            | Self::Update { key, .. } => (BitMask::ZERO, key.shard_index.bitmask()),
            Self::MoveValue {
                key_from, key_to, ..
            } => (
                BitMask::ZERO,
                key_from.shard_index.bitmask() | key_to.shard_index.bitmask(),
            ),
            Self::SwapValue { key_a, key_b, .. } => (
                BitMask::ZERO,
                key_a.shard_index.bitmask() | key_b.shard_index.bitmask(),
            ),
        }
    }
    pub fn apply<L, S>(
        &self,
        lock_guards: &mut LockGuards<'_, K, V, L>,
        indexer: &Indexer<S>,
        state: &mut STATE,
    ) where
        L: LockPolicy,
        S: BuildHasher,
    {
        match self {
            Self::Get { key, get } => {
                let shard =
                    if (key.shard_index.bitmask() & lock_guards.write_bitmask) != BitMask::ZERO {
                        lock_guards.write_guard(key).deref_mut()
                    } else {
                        lock_guards.read_guard(key).deref()
                    };
                let value_ref = ShardOps::value_ref(shard, key);
                (get)(&key.key, value_ref, state)
            }
            Self::InsertWith {
                key,
                value_generator,
            } => {
                let new_value = (value_generator)(&key.key, state);
                let write_guard = lock_guards.write_guard(key);
                ShardOps::insert::<K, V, S>(write_guard, key, new_value, indexer);
            }
            Self::InsertWithIfAbsent {
                key,
                value_generator,
            } => {
                let write_guard = lock_guards.write_guard(key);
                ShardOps::insert_if_absent::<K, V, S>(
                    write_guard,
                    key,
                    || (value_generator)(&key.key, state),
                    indexer,
                );
            }
            Self::Modify { key, mutate } => {
                let shard = lock_guards.write_guard(key);
                ShardOps::modify(shard, key, |k, v| mutate(k, v, state));
            }
            Self::MoveValue { key_from, key_to } => {
                MultiShardOps::move_value::<K, V, L, S>(
                    &mut lock_guards.write,
                    key_from,
                    key_to,
                    indexer,
                );
            }
            Self::Remove { key } => {
                let shard = lock_guards.write_guard(key);
                ShardOps::remove_entry::<K, V>(shard, key);
            }
            Self::RemoveIf { key, condition } => {
                let shard = lock_guards.write_guard(key);
                ShardOps::remove_if(shard, key, |k, v| condition(k, v, state), indexer);
            }
            Self::SwapValue { key_a, key_b } => {
                MultiShardOps::swap_value::<K, V, L, S>(
                    &mut lock_guards.write,
                    key_a,
                    key_b,
                    indexer,
                );
            }
            Self::Update { key, transform } => {
                let shard = lock_guards.write_guard(key);
                ShardOps::update(shard, key, |k, v_opt| transform(k, v_opt, state), indexer);
            }
        }
    }
}