llkv-btree 0.1.0-alpha

Generic, paged B+Tree with batch-only pager I/O for the LLKV toolset.
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

//! Defines the public API traits for B-Tree implementations.

pub use crate::codecs::{IdCodec, KeyCodec};
use crate::errors::Error;
pub use crate::pager::Pager;

#[cfg(feature = "debug")]
pub mod graphviz_ext;
#[cfg(feature = "debug")]
pub use graphviz_ext::*;

/// A generic ordered map interface over a B+Tree.
pub trait BTree<'a, K> {
    /// Tree returns **zero-copy** views;
    /// must deref to `&[u8]`.
    type Value: AsRef<[u8]> + Clone + 'a;

    /// Batched point lookups. The output vector lines up with `keys` by index.
    fn get_many(&'a self, keys: &[K]) -> Result<Vec<Option<Self::Value>>, Error>;

    fn contains_key(&'a self, key: &K) -> Result<bool, Error>;

    // Write methods now take &self, allowing for internal mutability.
    fn insert_many(&self, items: &[(K, &[u8])]) -> Result<(), Error>
    where
        K: Clone;

    fn delete_many(&self, keys: &[K]) -> Result<(), Error>
    where
        K: Clone;
}