masstree 0.9.5

A high-performance concurrent ordered map (trie of B+trees)
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
#![expect(clippy::unwrap_used)]
#![expect(clippy::panic)]

use crate::policy::ValuePtr;

use seize::LocalGuard;

use crate::{MassTree15, tree::generic::entry::Entry};

// ============================================================================
//  Entry API Tests
// ============================================================================

#[test]
fn test_entry_or_insert_vacant() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // Key doesn't exist, should insert
    let value: ValuePtr<u64> = tree.entry_with_guard(b"key", &guard).or_insert(42);
    assert_eq!(*value, 42);
    assert_eq!(tree.len(), 1);

    // Verify it was inserted
    assert_eq!(*tree.get_with_guard(b"key", &guard).unwrap(), 42);
}

#[test]
fn test_entry_or_insert_occupied() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // Pre-insert a value
    tree.insert_with_guard(b"key", 100, &guard);

    // Key exists, should return existing value, not insert
    let value: ValuePtr<u64> = tree.entry_with_guard(b"key", &guard).or_insert(42);
    assert_eq!(*value, 100);
    assert_eq!(tree.len(), 1);
}

#[test]
fn test_entry_or_insert() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // Insert on vacant
    let result: ValuePtr<u64> = tree.entry_with_guard(b"key", &guard).or_insert(42);
    assert_eq!(*result, 42);

    // Insert on occupied returns cached value
    let result: ValuePtr<u64> = tree.entry_with_guard(b"key", &guard).or_insert(100);
    assert_eq!(*result, 42); // Original value, not 100
}

#[derive(PartialEq, Eq)]
enum Bool {
    True,
    False,
}

#[test]
fn test_entry_or_insert_with_lazy() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    let mut called: Bool = Bool::False;
    let value: ValuePtr<u64> = tree.entry_with_guard(b"key", &guard).or_insert_with(|| {
        called = Bool::True;
        99
    });

    assert!(called == Bool::True);
    assert_eq!(*value, 99);
}

#[test]
fn test_entry_or_insert_with_not_called_when_occupied() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard = tree.guard();

    tree.insert_with_guard(b"key", 50, &guard);

    let mut called = false;
    let value: ValuePtr<u64> = tree.entry_with_guard(b"key", &guard).or_insert_with(|| {
        called = true;
        99
    });

    assert!(!called); // Should NOT be called
    assert_eq!(*value, 50);
}

#[test]
fn test_entry_or_insert_with_key() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // Insert based on key length
    let value: ValuePtr<u64> = tree
        .entry_with_guard(b"hello", &guard)
        .or_insert_with_key(|k: &[u8]| k.len() as u64);

    assert_eq!(*value, 5); // "hello".len() == 5
}

#[test]
fn test_entry_and_modify_occupied() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    tree.insert_with_guard(b"counter", 10, &guard);

    // Modify existing value (ValuePtr<u64>: dereference twice - &ValuePtr -> ValuePtr -> u64)
    let value: ValuePtr<u64> = tree
        .entry_with_guard(b"counter", &guard)
        .and_modify(|v: &ValuePtr<u64>| **v + 5)
        .or_insert(0);

    assert_eq!(*value, 15);
}

#[test]
fn test_entry_and_modify_vacant() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // and_modify should be skipped for vacant, or_insert should run
    let value = tree
        .entry_with_guard(b"counter", &guard)
        .and_modify(|v: &ValuePtr<u64>| **v + 100) // Should not be called
        .or_insert(0);

    assert_eq!(*value, 0);
}

#[test]
fn test_entry_try_and_modify() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    tree.insert_with_guard(b"counter", 10, &guard);

    // and_modify
    let result = tree
        .entry_with_guard(b"counter", &guard)
        .and_modify(|v: &ValuePtr<u64>| **v + 5);

    match result {
        Entry::Occupied(o) => assert_eq!(**o.get(), 15),

        Entry::Vacant(_) => panic!("Expected Occupied"),
    }
}

#[test]
fn test_entry_occupied_get() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    tree.insert_with_guard(b"key", 42, &guard);

    match tree.entry_with_guard(b"key", &guard) {
        Entry::Occupied(o) => {
            assert_eq!(**o.get(), 42);
            assert_eq!(o.key(), b"key");
        }

        Entry::Vacant(_) => panic!("Expected Occupied"),
    }
}

#[test]
fn test_entry_occupied_insert_returns_old() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard = tree.guard();

    tree.insert_with_guard(b"key", 10, &guard);

    match tree.entry_with_guard(b"key", &guard) {
        Entry::Occupied(mut o) => {
            let old = o.insert(20);
            assert_eq!(*old.unwrap(), 10); // Returns Some(old)
            assert_eq!(**o.get(), 20); // Cached value updated
        }

        Entry::Vacant(_) => panic!("Expected Occupied"),
    }

    assert_eq!(*tree.get_with_guard(b"key", &guard).unwrap(), 20);
}

#[test]
fn test_entry_occupied_try_insert() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard = tree.guard();

    tree.insert_with_guard(b"key", 10, &guard);

    match tree.entry_with_guard(b"key", &guard) {
        Entry::Occupied(mut o) => {
            let result = o.insert(20);
            assert_eq!(*result.unwrap(), 10);
        }

        Entry::Vacant(_) => panic!("Expected Occupied"),
    }
}

#[test]
fn test_entry_occupied_remove_returns_actual_value() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard = tree.guard();

    tree.insert_with_guard(b"key", 42, &guard);
    assert_eq!(tree.len(), 1);

    match tree.entry_with_guard(b"key", &guard) {
        Entry::Occupied(o) => {
            // Remove returns the actually removed value
            let value = o.remove();
            assert_eq!(*value.unwrap(), 42);
        }

        Entry::Vacant(_) => panic!("Expected Occupied"),
    }

    assert_eq!(tree.len(), 0);
    assert!(tree.get_with_guard(b"key", &guard).is_none());
}

#[test]
fn test_entry_occupied_try_remove() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    tree.insert_with_guard(b"key", 42, &guard);

    match tree.entry_with_guard(b"key", &guard) {
        Entry::Occupied(o) => {
            let result: Result<Option<ValuePtr<u64>>, crate::RemoveError> = o.try_remove();
            assert!(result.is_ok());
            assert_eq!(*result.unwrap().unwrap(), 42);
        }

        Entry::Vacant(_) => panic!("Expected Occupied"),
    }
}

#[test]
fn test_entry_occupied_remove_entry() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    tree.insert_with_guard(b"mykey", 123, &guard);

    match tree.entry_with_guard(b"mykey", &guard) {
        Entry::Occupied(o) => {
            let result = o.remove_entry();
            assert!(result.is_some());

            let (key, value) = result.unwrap();
            assert_eq!(key, b"mykey");
            assert_eq!(*value, 123);
        }

        Entry::Vacant(_) => panic!("Expected Occupied"),
    }
}

#[test]
fn test_entry_vacant_key() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    match tree.entry_with_guard(b"newkey", &guard) {
        Entry::Occupied(_) => panic!("Expected Vacant"),

        Entry::Vacant(v) => {
            assert_eq!(v.key(), b"newkey");
        }
    }
}

#[test]
fn test_entry_vacant_into_key() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    match tree.entry_with_guard(b"newkey", &guard) {
        Entry::Occupied(_) => panic!("Expected Vacant"),

        Entry::Vacant(v) => {
            let key: Vec<u8> = v.into_key();
            assert_eq!(key, b"newkey");
        }
    }
}

#[test]
fn test_entry_vacant_insert() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    match tree.entry_with_guard(b"newkey", &guard) {
        Entry::Occupied(_) => panic!("Expected Vacant"),

        Entry::Vacant(v) => {
            let value = v.insert(999);
            assert_eq!(*value, 999);
        }
    }

    assert_eq!(tree.len(), 1);
    assert_eq!(*tree.get_with_guard(b"newkey", &guard).unwrap(), 999);
}

#[test]
fn test_entry_vacant_try_insert() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    match tree.entry_with_guard(b"newkey", &guard) {
        Entry::Occupied(_) => panic!("Expected Vacant"),
        Entry::Vacant(v) => {
            let result = v.insert(777);
            assert_eq!(*result, 777);
        }
    }
}

#[test]
fn test_entry_insert_entry_from_vacant() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // Start vacant, insert_entry returns OccupiedEntry
    let occupied = tree.entry_with_guard(b"key", &guard).insert_entry(42);

    assert_eq!(**occupied.get(), 42);
    assert_eq!(occupied.key(), b"key");

    // Verify in tree
    assert_eq!(*tree.get_with_guard(b"key", &guard).unwrap(), 42);
}

#[test]
fn test_entry_insert_entry_from_occupied() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    tree.insert_with_guard(b"key", 10, &guard);

    // Start occupied, insert_entry replaces
    let occupied = tree.entry_with_guard(b"key", &guard).insert_entry(42);

    assert_eq!(**occupied.get(), 42);
    assert_eq!(*tree.get_with_guard(b"key", &guard).unwrap(), 42);
}

#[test]
fn test_entry_try_insert_entry() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    let result = tree.entry_with_guard(b"key", &guard).insert_entry(42);
    assert_eq!(**result.get(), 42);
}

#[test]
fn test_entry_get_on_entry() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // Vacant entry - get returns None
    let entry = tree.entry_with_guard(b"key", &guard);
    assert!(entry.get().is_none());

    // Insert and check again
    tree.insert_with_guard(b"key", 42, &guard);
    let entry = tree.entry_with_guard(b"key", &guard);
    assert_eq!(**entry.get().unwrap(), 42);
}

#[test]
fn test_entry_key_method() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // Vacant
    let entry = tree.entry_with_guard(b"vacant_key", &guard);
    assert_eq!(entry.key(), b"vacant_key");

    // Occupied
    tree.insert_with_guard(b"occupied_key", 1, &guard);
    let entry = tree.entry_with_guard(b"occupied_key", &guard);
    assert_eq!(entry.key(), b"occupied_key");
}

#[test]
fn test_entry_inline_variant() {
    use crate::MassTree15Inline;

    let tree: MassTree15Inline<u64> = MassTree15Inline::new();
    let guard = tree.guard();

    // Test or_insert (inline: value is u64 directly)
    let value = tree.entry_with_guard(b"key", &guard).or_insert(100);
    assert_eq!(value, 100);

    // Test and_modify (inline: v is &u64, dereference once)
    let value = tree
        .entry_with_guard(b"key", &guard)
        .and_modify(|v: &u64| *v + 50)
        .or_insert(0);
    assert_eq!(value, 150);
}

#[test]
fn test_entry_multiple_operations() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // Simulate a counter pattern (ValuePtr<u64>: dereference twice)
    for _ in 0..10 {
        tree.entry_with_guard(b"counter", &guard)
            .and_modify(|v| **v + 1)
            .or_insert(1);
    }

    // After 10 iterations: 1 (initial) + 9 increments = 10
    assert_eq!(*tree.get_with_guard(b"counter", &guard).unwrap(), 10);
}

#[test]
fn test_entry_different_keys() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // Insert multiple keys via entry API
    tree.entry_with_guard(b"a", &guard).or_insert(1);
    tree.entry_with_guard(b"b", &guard).or_insert(2);
    tree.entry_with_guard(b"c", &guard).or_insert(3);

    assert_eq!(tree.len(), 3);
    assert_eq!(*tree.get_with_guard(b"a", &guard).unwrap(), 1);
    assert_eq!(*tree.get_with_guard(b"b", &guard).unwrap(), 2);
    assert_eq!(*tree.get_with_guard(b"c", &guard).unwrap(), 3);
}

#[test]
fn test_entry_long_key() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // Key longer than 8 bytes (triggers multi-layer path)
    let long_key: &'static [u8; 48] = b"this_is_a_very_long_key_that_exceeds_eight_bytes";

    let value: ValuePtr<u64> = tree.entry_with_guard(long_key, &guard).or_insert(42);
    assert_eq!(*value, 42);

    // Verify retrieval
    assert_eq!(*tree.get_with_guard(long_key, &guard).unwrap(), 42);

    // Modify (ValuePtr<u64>: dereference twice)
    let value: ValuePtr<u64> = tree
        .entry_with_guard(long_key, &guard)
        .and_modify(|v: &ValuePtr<u64>| **v * 2)
        .or_insert(0);
    assert_eq!(*value, 84);
}

#[test]
fn test_entry_temporary_key_with_reused_guard() {
    // Verify that the key can be a temporary slice while reusing guard
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // This pattern should work: reuse guard with temporary keys
    for i in 0u64..5 {
        let key: String = format!("key_{i}");
        tree.entry_with_guard(key.as_bytes(), &guard).or_insert(i);
    }

    assert_eq!(tree.len(), 5);
    assert_eq!(*tree.get_with_guard(b"key_0", &guard).unwrap(), 0);
    assert_eq!(*tree.get_with_guard(b"key_4", &guard).unwrap(), 4);
}

#[test]
fn test_entry_or_default() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // or_default on vacant - uses Default::default() = 0
    let value: ValuePtr<u64> = tree.entry_with_guard(b"counter", &guard).or_default();
    assert_eq!(*value, 0);

    // Modify and or_default on occupied - returns cached value
    tree.insert_with_guard(b"other", 42, &guard);
    let value: ValuePtr<u64> = tree.entry_with_guard(b"other", &guard).or_default();
    assert_eq!(*value, 42);
}

#[test]
fn test_entry_or_default_with_and_modify() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // Counter pattern using or_default (ValuePtr<u64>: dereference twice)
    for _ in 0..5 {
        tree.entry_with_guard(b"counter", &guard)
            .and_modify(|v: &ValuePtr<u64>| **v + 1)
            .or_default();
    }

    // First iteration: or_default inserts 0
    // Iterations 2-5: and_modify increments (0 -> 1 -> 2 -> 3 -> 4)
    assert_eq!(*tree.get_with_guard(b"counter", &guard).unwrap(), 4);
}

#[test]
fn test_entry_or_try_insert_with_key() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // Insert based on key length
    let result: ValuePtr<u64> = tree
        .entry_with_guard(b"hello", &guard)
        .or_insert_with_key(|k| k.len() as u64);

    assert_eq!(*result, 5); // "hello".len() == 5

    // On occupied - returns cached value, closure not called
    let result: ValuePtr<u64> = tree
        .entry_with_guard(b"hello", &guard)
        .or_insert_with_key(|_| 999);

    assert_eq!(*result, 5); // Original value, not 999
}

#[test]
fn test_entry_debug_impl() {
    let tree: MassTree15<u64> = MassTree15::new();
    let guard: LocalGuard<'_> = tree.guard();

    // Vacant entry debug
    let entry = tree.entry_with_guard(b"key", &guard);
    let debug_str: String = format!("{entry:?}");
    assert!(debug_str.contains("Vacant"));

    // Occupied entry debug
    tree.insert_with_guard(b"key", 42, &guard);
    let entry = tree.entry_with_guard(b"key", &guard);
    let debug_str: String = format!("{entry:?}");
    assert!(debug_str.contains("Occupied"));
    assert!(debug_str.contains("42"));
}