heaplet 0.1.0

A small, in-process, Redis-inspired in-memory store for Rust.
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
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
//! Sorted set (zset) operations stored under a key.
//!
//! [`ZSetRef`] stores members with floating-point scores,
//! with deterministic ordering (ties resolved by member byte ordering).
//!
//! Internals keep two indexes:
//! - member -> score (updates / `zscore` / `zincrby`)
//! - score -> ordered members (range queries / ranks)
//!
//! Features:
//! - `zadd`, `zrem`, `zscore`, `zcard`
//! - ranges: `zrange`, `zrevrange`, `zrangebyscore`
//! - ranks: `zrank`, `zrevrank`
//! - score update: `zincrby`
//! - extremes: `zpopmin`, `zpopmax`
//! - scan: `zscan` (snapshot-based, deterministic paging)
//!
//! Notes:
//! - This is an MVP implementation optimized for clarity, not large-scale performance.

use std::collections::{BTreeMap, BTreeSet};

use ordered_float::OrderedFloat;
use serde::{Serialize, de::DeserializeOwned};

use crate::codec::{Bytes, Codec};
use crate::error::Error;
use crate::keys::matches_pattern_for_internal_use as matches_pattern;
use crate::keys::{ScanCursor, ScanPage};
use crate::store::Store;

type ScoreKey = OrderedFloat<f64>;
type ScoreIndex = BTreeMap<ScoreKey, BTreeSet<Bytes>>;

/// A Redis-inspired sorted set reference.
///
/// Members are stored as encoded bytes using the store's [`Codec`].
///
/// Internally, the zset maintains two indexes:
/// - `member_to_score`: member bytes -> score
/// - `score_to_members`: score -> ordered set of member bytes
///
/// # Notes
/// - Ordering is deterministic: ties are resolved by member byte ordering.
/// - This is an MVP implementation optimized for simplicity, not for large-scale performance.
///   Some APIs (e.g. `zrank`) scan the ordered view linearly.
pub struct ZSetRef<'a, C: Codec> {
    store: &'a Store<C>,
    key: &'a str,
}

impl<'a, C: Codec> ZSetRef<'a, C> {
    pub(crate) fn new(store: &'a Store<C>, key: &'a str) -> Self {
        Self { store, key }
    }

    #[inline]
    fn enc<T: Serialize>(&self, v: &T) -> Result<Bytes, Error> {
        self.store.codec().encode(v)
    }

    #[inline]
    fn dec<T: DeserializeOwned>(&self, b: &[u8]) -> Result<T, Error> {
        self.store.codec().decode(b)
    }

    // ---------- core index maintenance ----------

    /// Insert `member` into the score->members index.
    #[inline]
    fn index_insert(score_to_members: &mut ScoreIndex, score: f64, member: Bytes) {
        score_to_members
            .entry(OrderedFloat(score))
            .or_default()
            .insert(member);
    }

    /// Remove `member` from the score->members index.
    ///
    /// If the member set for a score becomes empty, the score bucket is removed.
    #[inline]
    fn index_remove(score_to_members: &mut ScoreIndex, score: f64, member: &Bytes) {
        let key = OrderedFloat(score);
        if let Some(set) = score_to_members.get_mut(&key) {
            set.remove(member);
            if set.is_empty() {
                score_to_members.remove(&key);
            }
        }
    }

    // ---------- APIs ----------

    /// Add or update `member` with `score`.
    ///
    /// Returns `true` if the member was newly inserted.
    pub fn zadd<T: Serialize>(&self, score: f64, member: &T) -> Result<bool, Error> {
        let m = self.enc(member)?;

        self.store.with_zset_mut(self.key, |ze| {
            if let Some(old) = ze.member_to_score.insert(m.clone(), score) {
                // Existing member updated.
                if old != score {
                    Self::index_remove(&mut ze.score_to_members, old, &m);
                    Self::index_insert(&mut ze.score_to_members, score, m);
                }
                Ok(false)
            } else {
                // New member.
                Self::index_insert(&mut ze.score_to_members, score, m);
                Ok(true)
            }
        })
    }

    /// Remove `member` from the zset.
    ///
    /// Returns `true` if the member existed.
    pub fn zrem<T: Serialize>(&self, member: &T) -> Result<bool, Error> {
        let m = self.enc(member)?;
        self.store.with_zset_mut(self.key, |ze| {
            let Some(old) = ze.member_to_score.remove(&m) else {
                return Ok(false);
            };
            Self::index_remove(&mut ze.score_to_members, old, &m);
            Ok(true)
        })
    }

    /// Return the score of `member`.
    pub fn zscore<T: Serialize>(&self, member: &T) -> Result<Option<f64>, Error> {
        let m = self.enc(member)?;
        self.store.with_zset_read(self.key, |opt| {
            let Some(ze) = opt else { return Ok(None) };
            Ok(ze.member_to_score.get(&m).copied())
        })
    }

    /// Return the cardinality of the zset.
    ///
    /// Missing keys return `0`.
    pub fn zcard(&self) -> Result<usize, Error> {
        self.store.with_zset_read(self.key, |opt| {
            Ok(opt.map(|ze| ze.member_to_score.len()).unwrap_or(0))
        })
    }

    /// Range by rank (inclusive), supporting negative indices.
    pub fn zrange<T: DeserializeOwned>(&self, start: isize, stop: isize) -> Result<Vec<T>, Error> {
        self.range_by_rank::<T>(start, stop, /* rev = */ false)
    }

    /// Reverse range by rank (inclusive), supporting negative indices.
    pub fn zrevrange<T: DeserializeOwned>(
        &self,
        start: isize,
        stop: isize,
    ) -> Result<Vec<T>, Error> {
        self.range_by_rank::<T>(start, stop, /* rev = */ true)
    }

    fn range_by_rank<T: DeserializeOwned>(
        &self,
        start: isize,
        stop: isize,
        rev: bool,
    ) -> Result<Vec<T>, Error> {
        self.store.with_zset_read(self.key, |opt| {
            let Some(ze) = opt else { return Ok(vec![]) };
            let n = ze.member_to_score.len() as isize;
            if n == 0 {
                return Ok(vec![]);
            }

            let mut s = if start < 0 { n + start } else { start };
            let mut e = if stop < 0 { n + stop } else { stop };

            if s < 0 {
                s = 0;
            }
            if e < 0 {
                return Ok(vec![]);
            }
            if s >= n {
                return Ok(vec![]);
            }
            if e >= n {
                e = n - 1;
            }
            if e < s {
                return Ok(vec![]);
            }

            let want_start = s as usize;
            let want_end = e as usize; // inclusive
            let mut out = Vec::with_capacity(want_end - want_start + 1);

            // iterate scores
            let iter_scores: Box<dyn Iterator<Item = (&ScoreKey, &BTreeSet<Bytes>)>> = if rev {
                Box::new(ze.score_to_members.iter().rev())
            } else {
                Box::new(ze.score_to_members.iter())
            };

            let mut idx = 0usize;
            for (_score, members) in iter_scores {
                // iterate members (tie-breaker order)
                let iter_members: Box<dyn Iterator<Item = &Bytes>> = if rev {
                    Box::new(members.iter().rev())
                } else {
                    Box::new(members.iter())
                };

                for m in iter_members {
                    if idx >= want_start && idx <= want_end {
                        out.push(self.dec::<T>(m)?);
                    }
                    if idx > want_end {
                        return Ok(out);
                    }
                    idx += 1;
                }
            }

            Ok(out)
        })
    }

    /// Range by score (inclusive).
    ///
    /// Missing keys return an empty vector.
    pub fn zrangebyscore<T: DeserializeOwned>(&self, min: f64, max: f64) -> Result<Vec<T>, Error> {
        let lo = OrderedFloat(min);
        let hi = OrderedFloat(max);

        self.store.with_zset_read(self.key, |opt| {
            let Some(ze) = opt else { return Ok(vec![]) };
            let mut out = Vec::new();
            for (_score, members) in ze.score_to_members.range(lo..=hi) {
                for m in members.iter() {
                    out.push(self.dec::<T>(m)?);
                }
            }
            Ok(out)
        })
    }

    /// Return the rank of `member` (0-based) in ascending order.
    pub fn zrank<T: Serialize>(&self, member: &T) -> Result<Option<usize>, Error> {
        self.rank_of(member, /* rev = */ false)
    }

    /// Return the rank of `member` (0-based) in descending order.
    pub fn zrevrank<T: Serialize>(&self, member: &T) -> Result<Option<usize>, Error> {
        self.rank_of(member, /* rev = */ true)
    }

    fn rank_of<T: Serialize>(&self, member: &T, rev: bool) -> Result<Option<usize>, Error> {
        let m = self.enc(member)?;
        self.store.with_zset_read(self.key, |opt| {
            let Some(ze) = opt else { return Ok(None) };
            let Some(score) = ze.member_to_score.get(&m).copied() else {
                return Ok(None);
            };

            let mut idx = 0usize;
            let iter_scores: Box<dyn Iterator<Item = (&ScoreKey, &BTreeSet<Bytes>)>> = if rev {
                Box::new(ze.score_to_members.iter().rev())
            } else {
                Box::new(ze.score_to_members.iter())
            };

            for (s, members) in iter_scores {
                let iter_members: Box<dyn Iterator<Item = &Bytes>> = if rev {
                    Box::new(members.iter().rev())
                } else {
                    Box::new(members.iter())
                };

                for mm in iter_members {
                    if *s == OrderedFloat(score) && *mm == m {
                        return Ok(Some(idx));
                    }
                    idx += 1;
                }
            }

            Ok(None)
        })
    }

    /// Increment `member` by `delta` and return the new score.
    ///
    /// Missing members start from `0.0`.
    pub fn zincrby<T: Serialize>(&self, member: &T, delta: f64) -> Result<f64, Error> {
        let m = self.enc(member)?;
        self.store.with_zset_mut(self.key, |ze| {
            let old = ze.member_to_score.get(&m).copied().unwrap_or(0.0);
            let next = old + delta;

            if ze.member_to_score.contains_key(&m) {
                Self::index_remove(&mut ze.score_to_members, old, &m);
            }
            ze.member_to_score.insert(m.clone(), next);
            Self::index_insert(&mut ze.score_to_members, next, m);

            Ok(next)
        })
    }

    /// Pop (remove) and return the minimum-score member.
    ///
    /// Returns `None` if missing/empty.
    pub fn zpopmin<T: DeserializeOwned>(&self) -> Result<Option<(T, f64)>, Error> {
        self.pop_extreme::<T>(/* max = */ false)
    }

    /// Pop (remove) and return the maximum-score member.
    ///
    /// Returns `None` if missing/empty.
    pub fn zpopmax<T: DeserializeOwned>(&self) -> Result<Option<(T, f64)>, Error> {
        self.pop_extreme::<T>(/* max = */ true)
    }

    fn pop_extreme<T: DeserializeOwned>(&self, max: bool) -> Result<Option<(T, f64)>, Error> {
        self.store.with_zset_mut(self.key, |ze| {
            let (score_key, members_snapshot) = if max {
                match ze.score_to_members.iter().next_back() {
                    None => return Ok(None),
                    Some((s, m)) => (*s, m.clone()),
                }
            } else {
                match ze.score_to_members.iter().next() {
                    None => return Ok(None),
                    Some((s, m)) => (*s, m.clone()),
                }
            };

            let member = members_snapshot
                .iter()
                .next()
                .cloned()
                .expect("members not empty");
            let score = score_key.0;

            ze.member_to_score.remove(&member);
            Self::index_remove(&mut ze.score_to_members, score, &member);

            let decoded = self.dec::<T>(&member)?;
            Ok(Some((decoded, score)))
        })
    }

    /// Remove members with scores in `[min, max]` (inclusive).
    ///
    /// Returns the number of removed members.
    pub fn zremrangebyscore(&self, min: f64, max: f64) -> Result<usize, Error> {
        let lo = OrderedFloat(min);
        let hi = OrderedFloat(max);

        self.store.with_zset_mut(self.key, |ze| {
            // Collect targets first (avoid mutating while iterating ranges).
            let mut to_remove: Vec<(Bytes, f64)> = Vec::new();
            for (s, members) in ze.score_to_members.range(lo..=hi) {
                for m in members.iter() {
                    to_remove.push((m.clone(), s.0));
                }
            }

            for (m, s) in &to_remove {
                ze.member_to_score.remove(m);
                Self::index_remove(&mut ze.score_to_members, *s, m);
            }

            Ok(to_remove.len())
        })
    }

    /// Remove members in the rank range `[start, stop]` (inclusive), supporting negative indices.
    ///
    /// Returns the number of removed members.
    pub fn zremrangebyrank(&self, start: isize, stop: isize) -> Result<usize, Error> {
        self.store.with_zset_mut(self.key, |ze| {
            let n = ze.member_to_score.len() as isize;
            if n == 0 {
                return Ok(0);
            }

            let mut s = if start < 0 { n + start } else { start };
            let mut e = if stop < 0 { n + stop } else { stop };

            if s < 0 {
                s = 0;
            }
            if e < 0 {
                return Ok(0);
            }
            if s >= n {
                return Ok(0);
            }
            if e >= n {
                e = n - 1;
            }
            if e < s {
                return Ok(0);
            }

            let want_start = s as usize;
            let want_end = e as usize;

            let mut idx = 0usize;
            let mut targets: Vec<(Bytes, f64)> = Vec::new();

            for (score_key, members) in ze.score_to_members.iter() {
                for m in members.iter() {
                    if idx >= want_start && idx <= want_end {
                        targets.push((m.clone(), score_key.0));
                    }
                    if idx > want_end {
                        break;
                    }
                    idx += 1;
                }
                if idx > want_end {
                    break;
                }
            }

            for (m, sc) in &targets {
                ze.member_to_score.remove(m);
                Self::index_remove(&mut ze.score_to_members, *sc, m);
            }

            Ok(targets.len())
        })
    }

    /// Cursor-based scan over members (MVP: snapshot + stable paging).
    ///
    /// - `cursor`: start from `ScanCursor(0)`
    /// - `pattern`: optional glob-like matcher (currently MVP-style, `*` supported)
    /// - `count`: page size hint
    ///
    /// # Pattern semantics
    /// Pattern filtering is performed on members decoded as `String`.
    /// Members that cannot be decoded as `String` are skipped when `pattern` is provided.
    pub fn zscan<T: DeserializeOwned>(
        &self,
        cursor: ScanCursor,
        pattern: Option<&str>,
        count: usize,
    ) -> Result<ScanPage<(T, f64)>, Error> {
        // Snapshot to stable vec (member, score).
        let mut items: Vec<(Bytes, f64)> = self.store.with_zset_read(self.key, |opt| {
            let Some(ze) = opt else { return Ok(vec![]) };
            let mut out = Vec::with_capacity(ze.member_to_score.len());
            for (m, s) in ze.member_to_score.iter() {
                out.push((m.clone(), *s));
            }
            Ok(out)
        })?;

        // Optional pattern matching via String decoding.
        if let Some(pat) = pattern {
            let mut filtered = Vec::new();
            for (m, s) in items.into_iter() {
                if let Ok(as_str) = self.dec::<String>(&m)
                    && matches_pattern(&as_str, pat)
                {
                    filtered.push((m, s));
                }
            }
            items = filtered;
        }

        // Stable ordering for deterministic paging.
        items.sort_by(|a, b| a.0.cmp(&b.0));

        let len = items.len();
        if len == 0 {
            return Ok(ScanPage {
                cursor: ScanCursor(0),
                items: vec![],
            });
        }

        let start = cursor.0 as usize;
        if start >= len {
            return Ok(ScanPage {
                cursor: ScanCursor(0),
                items: vec![],
            });
        }

        let take = count.max(1);
        let end = (start + take).min(len);
        let next = if end >= len { 0 } else { end as u64 };

        let mut out = Vec::with_capacity(end - start);
        for (m, s) in items.into_iter().skip(start).take(end - start) {
            out.push((self.dec::<T>(&m)?, s));
        }

        Ok(ScanPage {
            cursor: ScanCursor(next),
            items: out,
        })
    }
}

#[cfg(test)]
mod tests {
    use crate::Store;

    #[test]
    fn zset_basic_ops() {
        let store = Store::new();
        let z = store.zset("rank");

        assert_eq!(z.zcard().unwrap(), 0);
        assert!(z.zadd(10.0, &"a").unwrap());
        assert!(!z.zadd(12.0, &"a").unwrap()); // update

        assert!(z.zadd(11.0, &"b").unwrap());
        assert_eq!(z.zcard().unwrap(), 2);
        assert_eq!(z.zscore(&"a").unwrap(), Some(12.0));

        let r: Vec<String> = z.zrange(0, -1).unwrap();
        assert_eq!(r, vec!["b".to_string(), "a".to_string()]);
    }

    #[test]
    fn zset_rank_pop_remove_ranges() {
        let store = Store::new();
        let z = store.zset("z2");

        z.zadd(1.0, &"a").unwrap();
        z.zadd(2.0, &"b").unwrap();
        z.zadd(3.0, &"c").unwrap();

        assert_eq!(z.zrank(&"a").unwrap(), Some(0));
        assert_eq!(z.zrevrank(&"a").unwrap(), Some(2));

        let p: Option<(String, f64)> = z.zpopmin().unwrap();
        assert_eq!(p.unwrap().0, "a".to_string());

        let removed = z.zremrangebyscore(2.0, 3.0).unwrap();
        assert_eq!(removed, 2);
        assert_eq!(z.zcard().unwrap(), 0);
    }

    #[test]
    fn zset_incr_and_revrange() {
        let store = Store::new();
        let z = store.zset("z3");

        z.zadd(1.0, &"a").unwrap();
        let v = z.zincrby(&"a", 2.5).unwrap();
        assert!((v - 3.5).abs() < 1e-9);

        let rr: Vec<String> = z.zrevrange(0, -1).unwrap();
        assert_eq!(rr, vec!["a".to_string()]);
    }

    #[test]
    fn zset_update_score_reorders() {
        let store = Store::new();
        let z = store.zset("z");

        z.zadd(1.0, &"a").unwrap();
        z.zadd(2.0, &"b").unwrap();

        let r1: Vec<String> = z.zrange(0, -1).unwrap();
        assert_eq!(r1, vec!["a", "b"]);

        // update a to higher score
        z.zadd(3.0, &"a").unwrap();

        let r2: Vec<String> = z.zrange(0, -1).unwrap();
        assert_eq!(r2, vec!["b", "a"]);
    }

    #[test]
    fn zset_edge_cases() {
        let store = Store::new();
        let z = store.zset("z");

        assert_eq!(z.zpopmax::<String>().unwrap(), None);
        assert!(!z.zrem(&"missing").unwrap());
        assert_eq!(z.zrank(&"missing").unwrap(), None);

        z.zadd(1.0, &"a").unwrap();
        z.zadd(2.0, &"b").unwrap();

        let empty: Vec<String> = z.zrangebyscore(10.0, 20.0).unwrap();
        assert!(empty.is_empty());

        let rr: Vec<String> = z.zrevrange(0, 0).unwrap();
        assert_eq!(rr, vec!["b".to_string()]);

        let p = z.zpopmax::<String>().unwrap();
        assert_eq!(p.unwrap().0, "b".to_string());
    }
}