ring-db 0.6.0

A Rust library for ring queries in high-dimensional vector spaces.
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

use memmap2::Mmap;
use std::{fs::File, path::Path};

use crate::error::Result;

/// Mmap `path` read-only, or return `None` if `total_bytes == 0`.
///
/// # Safety
/// Callers must ensure the file is not modified after this call.
pub(super) fn open_mmap(path: &Path, total_bytes: u64) -> Result<Option<Mmap>> {
    if total_bytes == 0 {
        return Ok(None);
    }
    let file = File::open(path)?;
    // SAFETY: caller guarantees the file is read-only from this point on.
    Ok(Some(unsafe { Mmap::map(&file) }?))
}

// ─── Builder trait ────────────────────────────────────────────────────────────
//
// No longer object-safe (finish consumes self by value) — that's intentional.
// RingDb<T: Payload> holds T::Builder as a concrete field, so no Box<dyn> needed.

/// Internal trait implemented by `SerdeStoreBuilder<T>` and `PodStoreBuilder<T>`.
///
/// The associated type `Store` ties the builder to the store it produces, which
/// lets `RingDb::build()` return a `SealedRingDb<T>` without knowing the
/// concrete storage type at the call site.
#[doc(hidden)]
pub trait PayloadBuilderOps<T> {
    type Store;

    fn push(&mut self, payload: T) -> Result<()>;

    /// Flush and mmap the temp file for in-memory-only use.
    fn finish(self) -> Result<Self::Store>;

    /// Flush, persist the payload file to `payloads_path`, and — for Serde
    /// storage — write the offset table to `offsets_path`.
    /// Pod storage ignores `offsets_path`.
    fn finish_persisted(self, payloads_path: &Path, offsets_path: &Path) -> Result<Self::Store>;
}