kivis 0.5.1

Type-safe database schema generation for Rust with support for custom storage backends, automatic indexing, and layered cache architectures
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

use crate::{BufferOpsContainer, Repository, Unifier, UnifierData};

/// Represents a batch operation: either insert or delete.
pub enum BatchOp<'a, K: UnifierData, V: UnifierData> {
    /// Insert operation with key and value references
    Insert {
        key: K::View<'a>,
        value: V::View<'a>,
    },
    /// Delete operation with key reference
    Delete { key: K::View<'a> },
}

/// A trait defining a storage backend for the database.
///
/// The storage backend is responsible for storing and retrieving records and their associated indexes.
/// It defines methods for inserting, getting, removing, and iterating over keys in the storage.
/// All storage operations are defined over serialized byte data.
pub trait Storage {
    /// The repository type that this storage uses for low-level key-value operations.
    type Repo: Repository<
            K = <<Self as Storage>::KeyUnifier as Unifier>::D,
            V = <<Self as Storage>::ValueUnifier as Unifier>::D,
        >;

    /// Unifier type used to serialize/deserialize keys.
    type KeyUnifier: Unifier + Default + Copy;

    /// Unifier type used to serialize/deserialize values.
    type ValueUnifier: Unifier + Default + Copy;

    /// Container for buffer operations that can be applied to the repository.
    type Container: BufferOpsContainer;

    /// Returns a reference to the underlying repository.
    fn repository(&self) -> &Self::Repo;

    /// Returns a mutable reference to the underlying repository.
    fn repository_mut(&mut self) -> &mut Self::Repo;
}