shardmap 0.3.1

Sharded embedded in-memory map with optional cache, protocol, and server internals
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
use super::*;

impl WorkerLocalEmbeddedStore {
    /// Returns a borrowed value slice for `key` without copying bytes.
    ///
    /// The slice is tied to this worker-local store's exclusive `&mut self`
    /// borrow. Use [`Self::get`] when an owned `Vec<u8>` is required.
    pub fn get_ref<'a>(&'a mut self, key: &[u8]) -> Option<&'a [u8]> {
        self.get_ref_if_local(key)
            .expect("worker-local embedded store key does not belong to this thread")
    }

    pub fn get_ref_if_local<'a>(
        &'a mut self,
        key: &[u8],
    ) -> Result<Option<&'a [u8]>, LocalRouteError> {
        let route = self.local_key_route(key)?;
        Ok(self.inner.local_get_ref_routed(route, key))
    }

    /// Returns a mutable point-key guard for `key`.
    ///
    /// The guard is tied to this worker's exclusive `&mut self` borrow, and
    /// replacements preserve the entry's existing TTL.
    pub fn get_mut<'a>(&'a mut self, key: &[u8]) -> Option<WorkerLocalEmbeddedRefMut<'a>> {
        self.get_mut_if_local(key)
            .expect("worker-local embedded store key does not belong to this thread")
    }

    pub fn get_mut_if_local<'a>(
        &'a mut self,
        key: &[u8],
    ) -> Result<Option<WorkerLocalEmbeddedRefMut<'a>>, LocalRouteError> {
        let route = self.local_key_route(key)?;
        Ok(self.inner.local_get_mut_routed(route, key))
    }

    pub fn get(&mut self, key: &[u8]) -> Option<Bytes> {
        self.get_if_local(key)
            .expect("worker-local embedded store key does not belong to this thread")
    }

    pub fn get_if_local(&mut self, key: &[u8]) -> Result<Option<Bytes>, LocalRouteError> {
        self.local_key_route(key)?;
        Ok(self.inner.local_get(key))
    }

    pub fn get_view<'a>(&'a mut self, key: &[u8]) -> WorkerLocalReadView<'a> {
        self.get_view_if_local(key)
            .expect("worker-local embedded store key does not belong to this thread")
    }

    #[inline(always)]
    pub fn get_owned_view_local(&mut self, key: &[u8]) -> OwnedEmbeddedReadView {
        self.inner.get_view(key)
    }

    #[inline(always)]
    pub fn get_owned_view_routed_local(
        &mut self,
        route: EmbeddedKeyRoute,
        key: &[u8],
    ) -> OwnedEmbeddedReadView {
        debug_assert!(self.owns_shard(route.shard_id));
        OwnedEmbeddedReadView::from_item(self.inner.local_get_slice_routed(route, key))
    }

    pub fn get_view_if_local<'a>(
        &'a mut self,
        key: &[u8],
    ) -> Result<WorkerLocalReadView<'a>, LocalRouteError> {
        let route = self.local_key_route(key)?;
        Ok(WorkerLocalReadView {
            item: self
                .inner
                .local_get_slice_routed(route, key)
                .map(WorkerLocalReadSlice::from_embedded),
        })
    }

    #[inline(always)]
    pub fn get_view_routed_local<'a>(
        &'a mut self,
        route: EmbeddedKeyRoute,
        key: &[u8],
    ) -> WorkerLocalReadView<'a> {
        debug_assert!(self.owns_shard(route.shard_id));
        WorkerLocalReadView {
            item: self
                .inner
                .local_get_slice_routed(route, key)
                .map(WorkerLocalReadSlice::from_embedded),
        }
    }

    #[inline(always)]
    pub fn get_ref_routed_local<'a>(
        &'a mut self,
        route: EmbeddedKeyRoute,
        key: &[u8],
    ) -> Option<&'a [u8]> {
        debug_assert!(self.owns_shard(route.shard_id));
        self.inner.local_get_ref_routed(route, key)
    }

    #[inline(always)]
    pub fn get_view_routed_no_ttl<'a>(
        &'a mut self,
        route: EmbeddedKeyRoute,
        key: &[u8],
    ) -> WorkerLocalReadView<'a> {
        self.get_view_routed_no_ttl_local(route, key)
    }

    #[inline(always)]
    pub fn get_view_routed_no_ttl_if_local<'a>(
        &'a mut self,
        route: EmbeddedKeyRoute,
        key: &[u8],
    ) -> Result<WorkerLocalReadView<'a>, LocalRouteError> {
        self.ensure_local_route(route)?;
        Ok(WorkerLocalReadView {
            item: self
                .inner
                .local_get_slice_routed_no_ttl(route, key)
                .map(WorkerLocalReadSlice::from_embedded),
        })
    }

    #[inline(always)]
    pub fn get_point_view_routed_no_ttl_local<'a>(
        &'a mut self,
        route: EmbeddedKeyRoute,
        key: &[u8],
    ) -> WorkerLocalReadView<'a> {
        debug_assert!(self.owns_shard(route.shard_id));
        WorkerLocalReadView {
            item: self
                .inner
                .local_get_point_ref_routed_no_ttl(route, key)
                .map(WorkerLocalReadSlice::from_local_slice),
        }
    }

    #[inline(always)]
    pub fn get_point_ref_routed_no_ttl_local<'a>(
        &'a mut self,
        route: EmbeddedKeyRoute,
        key: &[u8],
    ) -> Option<&'a [u8]> {
        debug_assert!(self.owns_shard(route.shard_id));
        self.inner.local_get_point_ref_routed_no_ttl(route, key)
    }

    #[inline(always)]
    pub fn get_prepared_point_view_no_ttl_local<'a>(
        &'a mut self,
        prepared: &PreparedPointKey,
    ) -> WorkerLocalReadView<'a> {
        debug_assert!(self.owns_shard(prepared.route().shard_id));
        WorkerLocalReadView {
            item: self
                .inner
                .local_get_point_ref_prepared_routed_no_ttl(prepared)
                .map(WorkerLocalReadSlice::from_local_slice),
        }
    }

    #[inline(always)]
    pub fn get_prepared_point_ref_no_ttl_local<'a>(
        &'a mut self,
        prepared: &PreparedPointKey,
    ) -> Option<&'a [u8]> {
        debug_assert!(self.owns_shard(prepared.route().shard_id));
        self.inner
            .local_get_point_ref_prepared_routed_no_ttl(prepared)
    }

    #[inline(always)]
    pub fn get_view_routed_no_ttl_local<'a>(
        &'a mut self,
        route: EmbeddedKeyRoute,
        key: &[u8],
    ) -> WorkerLocalReadView<'a> {
        debug_assert!(self.owns_shard(route.shard_id));
        WorkerLocalReadView {
            item: self
                .inner
                .local_get_ref_routed_no_ttl(route, key)
                .map(WorkerLocalReadSlice::from_local_slice),
        }
    }

    #[inline(always)]
    pub fn get_ref_routed_no_ttl_if_local<'a>(
        &'a mut self,
        route: EmbeddedKeyRoute,
        key: &[u8],
    ) -> Result<Option<&'a [u8]>, LocalRouteError> {
        self.ensure_local_route(route)?;
        Ok(self.inner.local_get_ref_routed_no_ttl(route, key))
    }

    #[inline(always)]
    pub fn get_ref_routed_no_ttl_local<'a>(
        &'a mut self,
        route: EmbeddedKeyRoute,
        key: &[u8],
    ) -> Option<&'a [u8]> {
        debug_assert!(self.owns_shard(route.shard_id));
        self.inner.local_get_ref_routed_no_ttl(route, key)
    }

    pub fn batch_get(&mut self, keys: Vec<Bytes>) -> Vec<Option<Bytes>> {
        self.batch_get_if_local(keys)
            .expect("worker-local embedded store batch includes keys owned by another thread")
    }

    pub fn batch_get_if_local(
        &mut self,
        keys: Vec<Bytes>,
    ) -> Result<Vec<Option<Bytes>>, LocalRouteError> {
        self.ensure_local_keys(&keys)?;
        Ok(keys
            .into_iter()
            .map(|key| self.inner.local_get(&key))
            .collect::<Vec<_>>())
    }

    pub fn batch_get_view<'a>(&'a mut self, keys: &[Bytes]) -> WorkerLocalBatchReadView<'a> {
        self.batch_get_view_if_local(keys)
            .expect("worker-local embedded store batch includes keys owned by another thread")
    }

    #[inline(always)]
    pub fn batch_get_owned_view_local(&mut self, keys: &[Bytes]) -> OwnedEmbeddedBatchReadView {
        self.inner.batch_get_view(keys)
    }

    #[inline(always)]
    pub fn batch_get_owned_view_routed_local(
        &mut self,
        keys: &[(EmbeddedKeyRoute, Bytes)],
    ) -> OwnedEmbeddedBatchReadView {
        let items = keys
            .iter()
            .map(|(route, key)| {
                debug_assert!(self.owns_shard(route.shard_id));
                self.inner.local_get_slice_routed(*route, key)
            })
            .collect::<Vec<_>>();
        OwnedEmbeddedBatchReadView::from_items(items)
    }

    pub fn batch_get_view_if_local<'a>(
        &'a mut self,
        keys: &[Bytes],
    ) -> Result<WorkerLocalBatchReadView<'a>, LocalRouteError> {
        self.ensure_local_keys(keys)?;
        Ok(worker_local_batch_view_from_embedded(
            self.inner.local_batch_get_slices(keys),
        ))
    }

    pub fn batch_get_session_view<'a>(
        &'a mut self,
        session_prefix: &[u8],
        keys: &[Bytes],
    ) -> WorkerLocalSessionBatchView<'a> {
        self.batch_get_session_view_if_local(session_prefix, keys)
            .expect("worker-local embedded store session does not belong to this thread")
    }

    pub fn batch_get_session_view_if_local<'a>(
        &'a mut self,
        session_prefix: &[u8],
        keys: &[Bytes],
    ) -> Result<WorkerLocalSessionBatchView<'a>, LocalRouteError> {
        let key_hashes = keys
            .iter()
            .map(|key| crate::storage::hash_key(key))
            .collect::<Vec<_>>();
        self.batch_get_session_view_prehashed_if_local(session_prefix, keys, &key_hashes)
    }

    #[inline(always)]
    pub fn batch_get_session_owned_view_local(
        &mut self,
        session_prefix: &[u8],
        keys: &[Bytes],
    ) -> OwnedEmbeddedBatchReadView {
        self.inner.batch_get_session_view(session_prefix, keys)
    }

    #[inline(always)]
    pub fn batch_get_session_owned_view_routed_local(
        &mut self,
        route: EmbeddedSessionRoute,
        keys: &[Bytes],
    ) -> OwnedEmbeddedBatchReadView {
        debug_assert!(self.owns_shard(route.shard_id));
        self.inner.batch_get_session_view_routed_no_ttl(route, keys)
    }

    pub fn batch_get_session_view_prehashed_if_local<'a>(
        &'a mut self,
        session_prefix: &[u8],
        keys: &[Bytes],
        key_hashes: &[u64],
    ) -> Result<WorkerLocalSessionBatchView<'a>, LocalRouteError> {
        self.local_session_route(session_prefix)?;
        Ok(worker_local_batch_view_from_embedded(
            self.inner
                .local_batch_get_session_slices_prehashed(session_prefix, keys, key_hashes),
        ))
    }

    #[inline(always)]
    pub fn batch_get_session_owned_view_prehashed_local(
        &mut self,
        session_prefix: &[u8],
        keys: &[Bytes],
        key_hashes: &[u64],
    ) -> OwnedEmbeddedBatchReadView {
        self.inner
            .batch_get_session_view_prehashed(session_prefix, keys, key_hashes)
    }

    #[inline(always)]
    pub fn batch_get_session_owned_view_prehashed_routed_local(
        &mut self,
        route: EmbeddedSessionRoute,
        keys: &[Bytes],
        key_hashes: &[u64],
    ) -> OwnedEmbeddedBatchReadView {
        debug_assert!(self.owns_shard(route.shard_id));
        self.inner
            .batch_get_session_view_prehashed_routed_no_ttl(route, keys, key_hashes)
    }

    pub fn batch_get_session_packed(
        &mut self,
        session_prefix: &[u8],
        keys: &[Bytes],
    ) -> PackedBatch {
        self.batch_get_session_packed_if_local(session_prefix, keys)
            .expect("worker-local embedded store session does not belong to this thread")
    }

    pub fn batch_get_session_packed_if_local(
        &mut self,
        session_prefix: &[u8],
        keys: &[Bytes],
    ) -> Result<PackedBatch, LocalRouteError> {
        self.local_session_route(session_prefix)?;
        Ok(self.inner.batch_get_session_packed(session_prefix, keys))
    }

    #[inline(always)]
    pub fn batch_get_session_packed_routed_local(
        &mut self,
        route: EmbeddedSessionRoute,
        keys: &[Bytes],
    ) -> PackedBatch {
        debug_assert!(self.owns_shard(route.shard_id));
        self.inner
            .batch_get_session_packed_routed_no_ttl(route, keys)
    }

    pub fn batch_get_session_packed_view(
        &mut self,
        session_prefix: &[u8],
        keys: &[Bytes],
    ) -> Option<OwnedEmbeddedSessionPackedView> {
        self.batch_get_session_packed_view_if_local(session_prefix, keys)
            .expect("worker-local embedded store session does not belong to this thread")
    }

    pub fn batch_get_session_packed_view_if_local(
        &mut self,
        session_prefix: &[u8],
        keys: &[Bytes],
    ) -> Result<Option<OwnedEmbeddedSessionPackedView>, LocalRouteError> {
        let key_hashes = keys
            .iter()
            .map(|key| crate::storage::hash_key(key))
            .collect::<Vec<_>>();
        self.batch_get_session_packed_view_prehashed_if_local(session_prefix, keys, &key_hashes)
    }

    pub fn batch_get_session_packed_view_prehashed_if_local(
        &mut self,
        session_prefix: &[u8],
        keys: &[Bytes],
        key_hashes: &[u64],
    ) -> Result<Option<OwnedEmbeddedSessionPackedView>, LocalRouteError> {
        self.local_session_route(session_prefix)?;
        Ok(self
            .inner
            .batch_get_session_packed_view_prehashed(session_prefix, keys, key_hashes))
    }

    pub fn batch_get_packed(&mut self, keys: &[Bytes]) -> PackedBatch {
        self.batch_get_packed_if_local(keys)
            .expect("worker-local embedded store batch includes keys owned by another thread")
    }

    pub fn batch_get_packed_if_local(
        &mut self,
        keys: &[Bytes],
    ) -> Result<PackedBatch, LocalRouteError> {
        self.ensure_local_keys(keys)?;
        Ok(self.inner.batch_get_packed(keys))
    }
}