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
//! String / KV operations.
//!
//! [`KvOps`] stores a single value under each key (Redis `STRING`-like),
//! encoded/decoded via the store [`Codec`].
//!
//! Highlights:
//! - typed `set<T>()` / `get<T>()`, plus `mget` / `mset`
//! - conditional sets: `setnx`, `setxx`
//! - numeric ops: `incr`, `incrby`, `incrbyfloat`
//! - byte helpers: `append`, `strlen`
//!
//! Type mismatches return [`Error::WrongType`].

use serde::{Serialize, de::DeserializeOwned};
use std::time::{Duration, Instant};

use crate::codec::{Bytes, Codec};
use crate::entry::{Entry, Meta, StringEntry, ValueType};
use crate::error::Error;
use crate::store::Store;

/// String (KV) operations.
///
/// Values are encoded/decoded using the store's [`Codec`]. This layer is
/// Redis-inspired but intentionally Rusty (typed `get<T>()`, `set<T>()`).
///
/// # Semantics (MVP)
/// - Most operations treat missing keys as absent (`get` returns `Ok(None)`).
/// - Expiration is checked lazily on access.
/// - If a key exists but holds a different value type (hash/set/list/...), methods
///   return [`Error::WrongType`].
///
/// # Example
///
/// ```rust
/// use heaplet::Store;
///
/// let store = Store::new();
///
/// // Typed set/get.
/// store.kv().set("k", &123_i64).unwrap();
/// let v: Option<i64> = store.kv().get("k").unwrap();
/// assert_eq!(v, Some(123));
///
/// // Conditional set.
/// assert!(store.kv().setnx("nx", &"a").unwrap());
/// assert!(!store.kv().setnx("nx", &"b").unwrap());
///
/// // Numeric ops.
/// assert_eq!(store.kv().incr("n").unwrap(), 1);
/// assert_eq!(store.kv().incrby("n", 9).unwrap(), 10);
///
/// // Byte append (raw bytes, not codec re-encoding).
/// assert_eq!(store.kv().append("s", "hi").unwrap(), 2);
/// assert_eq!(store.kv().strlen("s").unwrap(), 2);
/// ```
pub struct KvOps<'a, C: Codec> {
    store: &'a Store<C>,
}

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

    // ---------- basic get/set ----------

    /// Set `key` to `value`, overwriting any existing value.
    ///
    /// If `key` previously existed with a different value type, it will be
    /// replaced with a string value (Redis `SET`-like semantics).
    pub fn set<T: Serialize>(&self, key: &str, value: &T) -> Result<(), Error> {
        let bytes = self.store.codec().encode(value)?;
        self.store.put_string_entry(key, bytes);
        Ok(())
    }

    /// Get the value stored at `key` and decode it as `T`.
    ///
    /// Returns:
    /// - `Ok(None)` if the key does not exist (or has expired)
    /// - `Err(WrongType)` if the key exists but is not a string value
    pub fn get<T: DeserializeOwned>(&self, key: &str) -> Result<Option<T>, Error> {
        self.store.purge_if_expired(key);

        let Some(entry) = self.store.get_entry(key) else {
            return Ok(None);
        };

        match entry {
            Entry::String(se) => Ok(Some(self.store.codec().decode::<T>(&se.bytes)?)),
            other => Err(Error::WrongType {
                expected: ValueType::String.as_str(),
                got: other.value_type().as_str(),
            }),
        }
    }

    /// Get multiple keys at once.
    ///
    /// The output vector has the same length/order as `keys`.
    pub fn mget<T: DeserializeOwned>(&self, keys: &[&str]) -> Result<Vec<Option<T>>, Error> {
        let mut out = Vec::with_capacity(keys.len());
        for k in keys {
            out.push(self.get::<T>(k)?);
        }
        Ok(out)
    }

    /// Set multiple key/value pairs.
    pub fn mset<T: Serialize>(&self, pairs: &[(&str, T)]) -> Result<(), Error> {
        for (k, v) in pairs {
            self.set(k, v)?;
        }
        Ok(())
    }

    // ---------- conditional set ----------

    /// Set `key` only if it does not already exist.
    ///
    /// Returns `true` if the key was set, `false` if it already existed.
    pub fn setnx<T: Serialize>(&self, key: &str, value: &T) -> Result<bool, Error> {
        let bytes = self.store.codec().encode(value)?;
        self.store.purge_if_expired(key);

        let ok = self.store.with_map_write(|m| {
            if m.contains_key(key) {
                return false;
            }
            m.insert(
                key.to_string(),
                Entry::String(StringEntry {
                    meta: Meta::new(ValueType::String),
                    bytes: bytes.clone(),
                }),
            );
            true
        });

        Ok(ok)
    }

    /// Set `key` only if it already exists and is a string.
    ///
    /// Returns:
    /// - `Ok(true)` if updated
    /// - `Ok(false)` if key does not exist
    /// - `Err(WrongType)` if key exists but is not a string
    pub fn setxx<T: Serialize>(&self, key: &str, value: &T) -> Result<bool, Error> {
        enum SetXx {
            Updated,
            Missing,
            WrongType(ValueType),
        }

        let bytes = self.store.codec().encode(value)?;
        self.store.purge_if_expired(key);

        let outcome = self.store.with_map_write(|m| {
            let Some(existing) = m.get_mut(key) else {
                return SetXx::Missing;
            };

            match existing {
                Entry::String(se) => {
                    // Preserve TTL/meta; only replace bytes.
                    se.bytes = bytes.clone();
                    SetXx::Updated
                }
                other => SetXx::WrongType(other.value_type()),
            }
        });

        match outcome {
            SetXx::Updated => Ok(true),
            SetXx::Missing => Ok(false),
            SetXx::WrongType(got) => Err(Error::WrongType {
                expected: ValueType::String.as_str(),
                got: got.as_str(),
            }),
        }
    }

    // ---------- get variants ----------

    /// Get the current value and delete the key.
    pub fn getdel<T: DeserializeOwned>(&self, key: &str) -> Result<Option<T>, Error> {
        self.store.purge_if_expired(key);

        let removed = self.store.with_map_write(|m| m.remove(key));
        let Some(entry) = removed else {
            return Ok(None);
        };

        match entry {
            Entry::String(se) => Ok(Some(self.store.codec().decode::<T>(&se.bytes)?)),
            other => Err(Error::WrongType {
                expected: ValueType::String.as_str(),
                got: other.value_type().as_str(),
            }),
        }
    }

    /// Get the value and (if it exists) set a new TTL in seconds.
    pub fn getex<T: DeserializeOwned>(&self, key: &str, seconds: u64) -> Result<Option<T>, Error> {
        let v = self.get::<T>(key)?;
        if v.is_some() {
            let when = Instant::now() + Duration::from_secs(seconds);
            self.store.set_expire_at(key, Some(when));
        }
        Ok(v)
    }

    // ---------- numeric ops (bincode i64 / f64) ----------

    /// Increment the integer value stored at `key` by 1.
    pub fn incr(&self, key: &str) -> Result<i64, Error> {
        self.incrby(key, 1)
    }

    /// Decrement the integer value stored at `key` by 1.
    pub fn decr(&self, key: &str) -> Result<i64, Error> {
        self.decrby(key, 1)
    }

    /// Increment the integer value stored at `key` by `delta`.
    ///
    /// - Missing keys are treated as 0 and created.
    /// - If the key exists but is not a string, returns `WrongType`.
    ///
    /// # Notes
    /// This decodes the stored bytes as `i64`. If decoding fails (for example,
    /// the key was previously set to a non-`i64` value), this MVP falls back to
    /// interpreting the current value as "some bytes" and uses `bytes.len()` as
    /// a best-effort numeric base before applying `delta`.
    pub fn incrby(&self, key: &str, delta: i64) -> Result<i64, Error> {
        self.store.purge_if_expired(key);

        let new_val = self.store.with_map_write(|m| match m.get_mut(key) {
            None => {
                let v = delta;
                let bytes = self.store.codec().encode(&v)?;
                m.insert(
                    key.to_string(),
                    Entry::String(StringEntry {
                        meta: Meta::new(ValueType::String),
                        bytes,
                    }),
                );
                Ok::<_, Error>(v)
            }
            Some(entry) => match entry {
                Entry::String(se) => {
                    let base = match self.store.codec().decode::<i64>(&se.bytes) {
                        Ok(n) => n,
                        Err(_) => se.bytes.len() as i64,
                    };

                    let v = base.saturating_add(delta);
                    se.bytes = self.store.codec().encode(&v)?;
                    Ok(v)
                }
                other => Err(Error::WrongType {
                    expected: ValueType::String.as_str(),
                    got: other.value_type().as_str(),
                }),
            },
        })?;

        Ok(new_val)
    }

    /// Decrement the integer value stored at `key` by `delta`.
    pub fn decrby(&self, key: &str, delta: i64) -> Result<i64, Error> {
        self.incrby(key, -delta)
    }

    /// Increment the floating-point value stored at `key` by `delta`.
    ///
    /// Missing keys are treated as 0.0 and created.
    pub fn incrbyfloat(&self, key: &str, delta: f64) -> Result<f64, Error> {
        self.store.purge_if_expired(key);

        let new_val = self.store.with_map_write(|m| match m.get_mut(key) {
            None => {
                let v = delta;
                let bytes = self.store.codec().encode(&v)?;
                m.insert(
                    key.to_string(),
                    Entry::String(StringEntry {
                        meta: Meta::new(ValueType::String),
                        bytes,
                    }),
                );
                Ok::<_, Error>(v)
            }
            Some(entry) => match entry {
                Entry::String(se) => {
                    let cur: f64 = self.store.codec().decode(&se.bytes)?;
                    let v = cur + delta;
                    se.bytes = self.store.codec().encode(&v)?;
                    Ok(v)
                }
                other => Err(Error::WrongType {
                    expected: ValueType::String.as_str(),
                    got: other.value_type().as_str(),
                }),
            },
        })?;

        Ok(new_val)
    }

    // ---------- byte-string ops ----------

    /// Append UTF-8 bytes of `suffix` to the underlying stored bytes.
    ///
    /// # Notes
    /// This operates on raw bytes and does not re-encode via the codec.
    /// If you previously stored a typed value with bincode, appending may make
    /// subsequent typed decoding fail.
    pub fn append(&self, key: &str, suffix: &str) -> Result<usize, Error> {
        self.store.purge_if_expired(key);

        let suffix_bytes = suffix.as_bytes();

        let new_len = self.store.with_map_write(|m| match m.get_mut(key) {
            None => {
                let mut v = Vec::with_capacity(suffix_bytes.len());
                v.extend_from_slice(suffix_bytes);
                let bytes: Bytes = v.into();
                let len = bytes.len();
                m.insert(
                    key.to_string(),
                    Entry::String(StringEntry {
                        meta: Meta::new(ValueType::String),
                        bytes,
                    }),
                );
                Ok::<_, Error>(len)
            }
            Some(entry) => match entry {
                Entry::String(se) => {
                    let mut v = se.bytes.to_vec();
                    v.extend_from_slice(suffix_bytes);
                    se.bytes = Bytes::from(v);
                    Ok(se.bytes.len())
                }
                other => Err(Error::WrongType {
                    expected: ValueType::String.as_str(),
                    got: other.value_type().as_str(),
                }),
            },
        })?;

        Ok(new_len)
    }

    /// Returns the length of the underlying stored bytes.
    ///
    /// Missing keys return 0.
    pub fn strlen(&self, key: &str) -> Result<usize, Error> {
        self.store.purge_if_expired(key);

        let len = self.store.with_map_read(|m| match m.get(key) {
            None => Ok::<_, Error>(0),
            Some(entry) => match entry {
                Entry::String(se) => Ok(se.bytes.len()),
                other => Err(Error::WrongType {
                    expected: ValueType::String.as_str(),
                    got: other.value_type().as_str(),
                }),
            },
        })?;

        Ok(len)
    }

    /// Deletes `key` (shorthand for [`KeysOps::del`](crate::keys::KeysOps::del)).
    pub fn del(&self, key: &str) -> bool {
        self.store.remove_entry(key)
    }
}

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

    #[test]
    fn kv_mget_mset() {
        let store = Store::new();
        store.kv().mset(&[("a", 1_i64), ("b", 2_i64)]).unwrap();
        let v: Vec<Option<i64>> = store.kv().mget(&["a", "b", "c"]).unwrap();
        assert_eq!(v, vec![Some(1), Some(2), None]);
    }

    #[test]
    fn kv_setnx_setxx() {
        let store = Store::new();
        assert!(store.kv().setnx("k", &1_i64).unwrap());
        assert!(!store.kv().setnx("k", &2_i64).unwrap());

        assert!(store.kv().setxx("k", &3_i64).unwrap());
        let v: Option<i64> = store.kv().get("k").unwrap();
        assert_eq!(v, Some(3));

        assert!(!store.kv().setxx("missing", &1_i64).unwrap());
    }

    #[test]
    fn kv_getdel_getex() {
        let store = Store::new();
        store.kv().set("k", &"v").unwrap();
        let v: Option<String> = store.kv().getdel("k").unwrap();
        assert_eq!(v.as_deref(), Some("v"));
        let v2: Option<String> = store.kv().get("k").unwrap();
        assert_eq!(v2, None);

        store.kv().set("t", &"x").unwrap();
        let x: Option<String> = store.kv().getex("t", 1).unwrap();
        assert_eq!(x.as_deref(), Some("x"));
    }

    #[test]
    fn kv_incr_family() {
        let store = Store::new();

        // missing treated as 0
        assert_eq!(store.kv().incr("n").unwrap(), 1);

        store.kv().set("n", &10_i64).unwrap();
        assert_eq!(store.kv().incrby("n", 5).unwrap(), 15);
        assert_eq!(store.kv().decr("n").unwrap(), 14);
        assert_eq!(store.kv().decrby("n", 4).unwrap(), 10);
    }

    #[test]
    fn kv_incrbyfloat() {
        let store = Store::new();
        store.kv().set("f", &1.0_f64).unwrap();
        let v = store.kv().incrbyfloat("f", 0.25).unwrap();
        assert!((v - 1.25).abs() < 1e-9);
    }

    #[test]
    fn kv_append_strlen() {
        let store = Store::new();
        assert_eq!(store.kv().strlen("s").unwrap(), 0);
        assert_eq!(store.kv().append("s", "hi").unwrap(), 2);
        assert_eq!(store.kv().append("s", "!!!").unwrap(), 5);
        assert_eq!(store.kv().strlen("s").unwrap(), 5);
    }

    fn assert_wrong_type(err: Error, expected: &'static str) {
        match err {
            Error::WrongType {
                expected: e,
                got: _,
            } => assert_eq!(e, expected),
            other => panic!("expected WrongType, got: {:?}", other),
        }
    }

    #[test]
    fn kv_wrong_type_from_other_structures() {
        let store = Store::new();

        // hash -> kv.get should be wrong type
        store.hash("k").hset("a", &1_i64).unwrap();
        let err = store.kv().get::<i64>("k").unwrap_err();
        assert_wrong_type(err, "string");

        // set -> kv.get should be wrong type
        store.set("s").sadd(&"x").unwrap();
        let err = store.kv().get::<String>("s").unwrap_err();
        assert_wrong_type(err, "string");
    }

    #[test]
    fn kv_incr_on_non_number_overwrites_to_numeric() {
        let store = Store::new();
        let s = "not-a-number".to_string();
        store.kv().set("n", &s).unwrap();

        let v = store.kv().incr("n").unwrap();
        assert_eq!(v, (s.len() as i64) + 1);

        let cur: Option<i64> = store.kv().get("n").unwrap();
        assert_eq!(cur, Some(v));
    }
}