fuzzy_rocks 0.4.0

A persistent datastore backed by RocksDB with fuzzy key lookup using an arbitrary distance function accelerated by the SymSpell algorithm
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

//!
//! The Records module contains the logic for working with records.  RecordIDs are re-exported
//! to the public interface.
//! 

use serde::{Serialize, Deserialize};


/// A unique identifier for a record within a [Table](crate::Table)
/// 
/// NOTE: although the RecordID is 64 bits, only 44 bits can be used to address
/// records, giving a theoretical maximum of 17.6 trillion records although
/// this crate has only been tested with about 10 million unique records, so far
#[derive(Copy, Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd, derive_more::Display, Serialize, Deserialize)]
pub struct RecordID(pub usize);
impl RecordID {
    pub const NULL : RecordID = RecordID(usize::MAX);
}

impl RecordID {
    pub fn from(id : usize) -> Self {
        RecordID(id)
    }
    pub fn to_le_bytes(&self) -> [u8; 8] {
        self.0.to_le_bytes()
    }
}

/// Some meta-data associated with each record.  There is one of these for each record, and it
/// points to each KeyGroup that might have keys associated with the record
#[derive(Serialize, Deserialize)]
pub struct RecordData {
    pub key_groups : Vec<usize>,
    //DANGER: If any additional fields are added here, we must update `put_record_key_groups` to preserve
    // other fields before just overwriting it.
}

impl RecordData {
    pub fn new(key_groups : &[usize]) -> Self {
        Self{
            key_groups : key_groups.to_vec()
        }
    }
}