wedb_embed 0.1.13

Embedded database engine providing Redis-like APIs, built on fjall / 嵌入式数据库引擎,提供类似 Redis 的接口,底层基于 fjall 开发
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
use std::ops::Bound;

use crate::{
  IntoIndexRange,
  api::list::{
    ListItemKeyComposer, compose_list_item, compose_list_meta_key, compose_list_prefix_stack,
    r#const::ERR_INDEX_OUT_OF_RANGE, meta::ListMeta,
  },
  engine::{Engine, KvEntry, Partition},
  error::{Error, Result},
  key::{clear_prefix_in_batch, get_meta_checked},
  meta::current_now_ms,
  normalize_range,
  wedb::{Db, DbBatch},
};

/// List structure operations interface (Lists).
/// 列表结构操作接口 (Lists)
impl<E: Engine> Db<E>
where
  Error: From<E::Error>,
{
  #[inline]
  pub fn lpush_one<K: AsRef<[u8]>, V: AsRef<[u8]>>(&self, key: K, value: V) -> Result<u64> {
    list_push_one_internal(self, key.as_ref(), value.as_ref(), true, true)
  }

  #[inline]
  pub fn lpush<K: AsRef<[u8]>, V: AsRef<[u8]>>(&self, key: K, values: &[V]) -> Result<u64> {
    list_push_internal(self, key.as_ref(), values, true, true)
  }

  #[inline]
  pub fn rpush_one<K: AsRef<[u8]>, V: AsRef<[u8]>>(&self, key: K, value: V) -> Result<u64> {
    list_push_one_internal(self, key.as_ref(), value.as_ref(), true, false)
  }

  #[inline]
  pub fn rpush<K: AsRef<[u8]>, V: AsRef<[u8]>>(&self, key: K, values: &[V]) -> Result<u64> {
    list_push_internal(self, key.as_ref(), values, true, false)
  }

  #[inline]
  pub fn lpushx_one<K: AsRef<[u8]>, V: AsRef<[u8]>>(&self, key: K, value: V) -> Result<u64> {
    list_push_one_internal(self, key.as_ref(), value.as_ref(), false, true)
  }

  #[inline]
  pub fn lpushx<K: AsRef<[u8]>, V: AsRef<[u8]>>(&self, key: K, values: &[V]) -> Result<u64> {
    list_push_internal(self, key.as_ref(), values, false, true)
  }

  #[inline]
  pub fn rpushx_one<K: AsRef<[u8]>, V: AsRef<[u8]>>(&self, key: K, value: V) -> Result<u64> {
    list_push_one_internal(self, key.as_ref(), value.as_ref(), false, false)
  }

  #[inline]
  pub fn rpushx<K: AsRef<[u8]>, V: AsRef<[u8]>>(&self, key: K, values: &[V]) -> Result<u64> {
    list_push_internal(self, key.as_ref(), values, false, false)
  }

  #[inline]
  pub fn lpop_one<K: AsRef<[u8]>>(&self, key: K) -> Result<Option<Vec<u8>>> {
    list_pop_one_internal(self, key.as_ref(), true)
  }

  #[inline]
  pub fn lpop<K: AsRef<[u8]>>(&self, key: K, count: usize) -> Result<Vec<Vec<u8>>> {
    list_pop_internal(self, key.as_ref(), count, true)
  }

  #[inline]
  pub fn rpop_one<K: AsRef<[u8]>>(&self, key: K) -> Result<Option<Vec<u8>>> {
    list_pop_one_internal(self, key.as_ref(), false)
  }

  #[inline]
  pub fn rpop<K: AsRef<[u8]>>(&self, key: K, count: usize) -> Result<Vec<Vec<u8>>> {
    list_pop_internal(self, key.as_ref(), count, false)
  }

  #[inline]
  pub fn llen<K: AsRef<[u8]>>(&self, key: K) -> Result<u64> {
    let key_bytes = key.as_ref();
    let kc = self.kc();
    let meta_k = compose_list_meta_key(&kc, key_bytes);
    let now_ms = current_now_ms();

    match get_meta_checked::<ListMeta, _>(self, key_bytes, &meta_k, now_ms)? {
      Some(m) => Ok(m.base.size),
      None => Ok(0),
    }
  }

  #[inline]
  pub fn lrange<K: AsRef<[u8]>>(&self, key: K, range: impl IntoIndexRange) -> Result<Vec<Vec<u8>>> {
    let (start, stop) = range.into_index_range();
    let key_bytes = key.as_ref();
    let kc = self.kc();
    let meta_k = compose_list_meta_key(&kc, key_bytes);
    let now_ms = current_now_ms();

    let meta = match get_meta_checked::<ListMeta, _>(self, key_bytes, &meta_k, now_ms)? {
      Some(m) => m,
      None => return Ok(Vec::new()),
    };

    if meta.base.size == 0 {
      return Ok(Vec::new());
    }

    let len = meta.base.size as i64;
    let (s, e) = normalize_range(start, stop, len);
    if s > e {
      return Ok(Vec::new());
    }

    let num_elems = (e - s + 1) as usize;
    let mut results = Vec::with_capacity(num_elems);
    let actual_start = meta.head.wrapping_add(s as u64);
    let actual_end = meta.head.wrapping_add(e as u64);

    if actual_start <= actual_end {
      let start_k = compose_list_item(&kc, key_bytes, actual_start);
      let end_k = compose_list_item(&kc, key_bytes, actual_end);
      for g in self.data().range((
        Bound::Included(start_k.as_slice()),
        Bound::Included(end_k.as_slice()),
      )) {
        let entry = g?;
        results.push(entry.value().to_vec());
      }
    } else {
      let mut composer = ListItemKeyComposer::new(&kc, key_bytes);
      let data_ks = self.data();
      for idx in s..=e {
        let actual_idx = meta.head.wrapping_add(idx as u64);
        let item_k = composer.key_for_idx(actual_idx);
        if let Some(val) = data_ks.get(item_k)? {
          results.push(val.to_vec());
        }
      }
    }
    Ok(results)
  }

  #[inline]
  pub fn with_lindex<K: AsRef<[u8]>, R>(
    &self,
    key: K,
    index: i64,
    f: impl FnOnce(&[u8]) -> R,
  ) -> Result<Option<R>> {
    let key_bytes = key.as_ref();
    let kc = self.kc();
    let meta_k = compose_list_meta_key(&kc, key_bytes);
    let now_ms = current_now_ms();

    let meta = match get_meta_checked::<ListMeta, _>(self, key_bytes, &meta_k, now_ms)? {
      Some(m) if m.base.size > 0 => m,
      _ => return Ok(None),
    };

    let offset = match resolve_list_offset(meta.base.size, index) {
      Some(off) => off,
      None => return Ok(None),
    };

    let mut composer = ListItemKeyComposer::new(&kc, key_bytes);
    let actual_idx = meta.head.wrapping_add(offset);
    let item_k = composer.key_for_idx(actual_idx);
    let val = self.data().get(item_k)?;
    Ok(val.as_deref().map(f))
  }

  #[inline]
  pub fn lindex<K: AsRef<[u8]>>(&self, key: K, index: i64) -> Result<Option<Vec<u8>>> {
    self.with_lindex(key, index, |v| v.to_vec())
  }

  #[inline]
  pub fn lset<K: AsRef<[u8]>, V: AsRef<[u8]>>(&self, key: K, index: i64, value: V) -> Result<()> {
    let key_bytes = key.as_ref();
    let kc = self.kc();
    let meta_k = compose_list_meta_key(&kc, key_bytes);
    let now_ms = current_now_ms();

    let meta = match get_meta_checked::<ListMeta, _>(self, key_bytes, &meta_k, now_ms)? {
      Some(m) if m.base.size > 0 => m,
      _ => return Err(Error::invalid_data(ERR_INDEX_OUT_OF_RANGE)),
    };

    let offset = match resolve_list_offset(meta.base.size, index) {
      Some(off) => off,
      None => return Err(Error::invalid_data(ERR_INDEX_OUT_OF_RANGE)),
    };

    let mut composer = ListItemKeyComposer::new(&kc, key_bytes);
    let actual_idx = meta.head.wrapping_add(offset);
    let item_k = composer.key_for_idx(actual_idx);

    let mut batch = self.batch_with_capacity(1);
    batch.insert_data(item_k, value.as_ref());
    batch.commit()?;

    Ok(())
  }

  #[inline]
  pub fn ltrim<K: AsRef<[u8]>>(&self, key: K, range: impl IntoIndexRange) -> Result<()> {
    let (start, stop) = range.into_index_range();
    let key_bytes = key.as_ref();
    let kc = self.kc();
    let meta_k = compose_list_meta_key(&kc, key_bytes);
    let now_ms = current_now_ms();

    let mut meta = match get_meta_checked::<ListMeta, _>(self, key_bytes, &meta_k, now_ms)? {
      Some(m) => m,
      None => return Ok(()),
    };

    if meta.base.size == 0 {
      return Ok(());
    }

    let len = meta.base.size as i64;
    let (s, e) = normalize_range(start, stop, len);

    let mut batch = self.batch_with_capacity(32);

    if s > e {
      let prefix = compose_list_prefix_stack(&kc, key_bytes);
      clear_prefix_in_batch(self.data(), &prefix, &mut batch)?;
      batch.rm_meta(&meta_k);
      batch.commit()?;
      return Ok(());
    }

    let mut composer = ListItemKeyComposer::new(&kc, key_bytes);

    for offset in 0..(s as u64) {
      let idx = meta.head.wrapping_add(offset);
      let item_k = composer.key_for_idx(idx);
      batch.rm_weak_data(item_k);
    }

    for offset in ((e + 1) as u64)..meta.base.size {
      let idx = meta.head.wrapping_add(offset);
      let item_k = composer.key_for_idx(idx);
      batch.rm_weak_data(item_k);
    }

    let new_size = (e - s + 1) as u64;
    let new_head = meta.head.wrapping_add(s as u64);
    let new_tail = new_head.wrapping_add(new_size);

    meta.base.size = new_size;
    meta.head = new_head;
    meta.tail = new_tail;

    commit_list_batch(&meta_k, &meta, batch)?;
    Ok(())
  }
}

#[inline]
pub(crate) fn commit_list_batch<E: Engine>(
  meta_k: &[u8],
  meta: &ListMeta,
  mut batch: DbBatch<E>,
) -> Result<()>
where
  Error: From<E::Error>,
{
  if meta.base.size == 0 {
    batch.rm_meta(meta_k);
  } else {
    batch.insert_meta(meta_k, &meta.encode());
  }
  batch.commit()?;
  Ok(())
}

#[inline]
pub fn prepare_list_meta_for_write<E: Engine>(
  db: &Db<E>,
  k_bytes: &[u8],
  meta_k: &[u8],
  now_ms: u64,
  batch: &mut DbBatch<E>,
) -> Result<(ListMeta, bool)>
where
  Error: From<E::Error>,
{
  let kc = db.kc();
  match get_meta_checked::<ListMeta, _>(db, k_bytes, meta_k, now_ms)? {
    Some(meta) => Ok((meta, true)),
    None => {
      let prefix = compose_list_prefix_stack(&kc, k_bytes);
      clear_prefix_in_batch(db.data(), &prefix, batch)?;
      Ok((ListMeta::new_with_version(0), false))
    }
  }
}

#[inline]
pub(crate) fn list_push_one_internal<E: Engine>(
  db: &Db<E>,
  key_bytes: &[u8],
  v_bytes: &[u8],
  create_if_missing: bool,
  push_left: bool,
) -> Result<u64>
where
  Error: From<E::Error>,
{
  let kc = db.kc();
  let meta_k = compose_list_meta_key(&kc, key_bytes);
  let now_ms = current_now_ms();

  let mut batch = db.batch_with_capacity(2);
  let (mut meta, metadata_existed) =
    prepare_list_meta_for_write(db, key_bytes, &meta_k, now_ms, &mut batch)?;

  if !create_if_missing && (!metadata_existed || meta.base.size == 0) {
    return Ok(0);
  }

  let mut composer = ListItemKeyComposer::new(&kc, key_bytes);
  let target_idx = meta.push_index(push_left);
  let item_k = composer.key_for_idx(target_idx);
  batch.insert_data(item_k, v_bytes);
  meta.base.size += 1;

  batch.insert_meta(&meta_k, &meta.encode());
  batch.commit()?;
  Ok(meta.base.size)
}

fn list_push_internal<E: Engine, V: AsRef<[u8]>>(
  db: &Db<E>,
  key_bytes: &[u8],
  values: &[V],
  create_if_missing: bool,
  push_left: bool,
) -> Result<u64>
where
  Error: From<E::Error>,
{
  if values.is_empty() {
    return Ok(0);
  }
  if values.len() == 1 {
    return list_push_one_internal(
      db,
      key_bytes,
      values[0].as_ref(),
      create_if_missing,
      push_left,
    );
  }
  let kc = db.kc();
  let meta_k = compose_list_meta_key(&kc, key_bytes);
  let now_ms = current_now_ms();

  let mut batch = db.batch_with_capacity(values.len() + 1);
  let (mut meta, metadata_existed) =
    prepare_list_meta_for_write(db, key_bytes, &meta_k, now_ms, &mut batch)?;

  if !create_if_missing && (!metadata_existed || meta.base.size == 0) {
    return Ok(0);
  }

  let mut composer = ListItemKeyComposer::new(&kc, key_bytes);

  for v in values {
    let v_bytes = v.as_ref();
    let target_idx = meta.push_index(push_left);
    let item_k = composer.key_for_idx(target_idx);
    batch.insert_data(item_k, v_bytes);
    meta.base.size += 1;
  }

  batch.insert_meta(&meta_k, &meta.encode());
  batch.commit()?;
  Ok(meta.base.size)
}

#[inline]
fn list_pop_one_internal<E: Engine>(
  db: &Db<E>,
  key_bytes: &[u8],
  pop_left: bool,
) -> Result<Option<Vec<u8>>>
where
  Error: From<E::Error>,
{
  let kc = db.kc();
  let meta_k = compose_list_meta_key(&kc, key_bytes);
  let now_ms = current_now_ms();

  let mut meta = match get_meta_checked::<ListMeta, _>(db, key_bytes, &meta_k, now_ms)? {
    Some(m) if m.base.size > 0 => m,
    _ => return Ok(None),
  };

  let target_idx = meta.pop_index(pop_left);
  let mut composer = ListItemKeyComposer::new(&kc, key_bytes);
  let item_k = composer.key_for_idx(target_idx);
  let val = match db.data().get(item_k)? {
    Some(v) => v.to_vec(),
    None => return Ok(None),
  };

  meta.base.size -= 1;
  let mut batch = db.batch_with_capacity(2);
  batch.rm_weak_data(item_k);
  commit_list_batch(&meta_k, &meta, batch)?;

  Ok(Some(val))
}

fn list_pop_internal<E: Engine>(
  db: &Db<E>,
  key_bytes: &[u8],
  count: usize,
  pop_left: bool,
) -> Result<Vec<Vec<u8>>>
where
  Error: From<E::Error>,
{
  if count == 0 {
    return Ok(Vec::new());
  }
  if count == 1 {
    return Ok(match list_pop_one_internal(db, key_bytes, pop_left)? {
      Some(v) => vec![v],
      None => Vec::new(),
    });
  }
  let kc = db.kc();
  let meta_k = compose_list_meta_key(&kc, key_bytes);
  let now_ms = current_now_ms();

  let mut meta = match get_meta_checked::<ListMeta, _>(db, key_bytes, &meta_k, now_ms)? {
    Some(m) if m.base.size > 0 => m,
    _ => return Ok(Vec::new()),
  };

  let actual_count = (count as u64).min(meta.base.size);
  let mut results = Vec::with_capacity(actual_count as usize);

  let mut batch = db.batch_with_capacity(actual_count as usize + 1);
  let mut composer = ListItemKeyComposer::new(&kc, key_bytes);
  let data_ks = db.data();

  for _ in 0..actual_count {
    let target_idx = meta.pop_index(pop_left);
    let item_k = composer.key_for_idx(target_idx);
    if let Some(val) = data_ks.get(item_k)? {
      results.push(val.to_vec());
      batch.rm_weak_data(item_k);
    }
  }

  meta.base.size -= actual_count;
  commit_list_batch(&meta_k, &meta, batch)?;

  Ok(results)
}

#[inline]
fn resolve_list_offset(size: u64, index: i64) -> Option<u64> {
  if size == 0 {
    return None;
  }
  let len = size as i64;
  let actual_offset = if index < 0 {
    len.checked_add(index)?
  } else {
    index
  };
  if actual_offset >= 0 && actual_offset < len {
    Some(actual_offset as u64)
  } else {
    None
  }
}