superbit_lsh 0.1.1

A lightweight, in-memory vector index for approximate nearest neighbors using Locality-Sensitive Hashing
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

//! Save and load the index to/from disk.
//!
//! Requires the `persistence` feature flag.

use std::path::Path;

use parking_lot::RwLock;

use crate::error::{LshError, Result};
use crate::index::{IndexInner, LshIndex};

impl LshIndex {
    /// Serialize the index to a JSON file.
    pub fn save_json(&self, path: &Path) -> Result<()> {
        let inner = self.inner.read();
        let json = serde_json::to_string_pretty(&*inner)
            .map_err(|e| LshError::Serialization(e.to_string()))?;
        std::fs::write(path, json)?;
        Ok(())
    }

    /// Deserialize an index from a JSON file.
    pub fn load_json(path: &Path) -> Result<Self> {
        let data = std::fs::read_to_string(path)?;
        let inner: IndexInner =
            serde_json::from_str(&data).map_err(|e| LshError::Serialization(e.to_string()))?;
        Ok(Self {
            inner: RwLock::new(inner),
            metrics: None,
        })
    }

    /// Serialize the index to a compact bincode file.
    pub fn save_bincode(&self, path: &Path) -> Result<()> {
        let inner = self.inner.read();
        let bytes = bincode::serialize(&*inner)
            .map_err(|e| LshError::Serialization(e.to_string()))?;
        std::fs::write(path, bytes)?;
        Ok(())
    }

    /// Deserialize an index from a bincode file.
    pub fn load_bincode(path: &Path) -> Result<Self> {
        let data = std::fs::read(path)?;
        let inner: IndexInner =
            bincode::deserialize(&data).map_err(|e| LshError::Serialization(e.to_string()))?;
        Ok(Self {
            inner: RwLock::new(inner),
            metrics: None,
        })
    }
}