native_db 0.8.2

Drop-in embedded database
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
53
54
55
56
57
58
59
60
61
62

use crate::database_builder::ModelBuilder;
use crate::db_type::{Key, KeyDefinition, KeyOptions};
use std::collections::HashMap;
use std::fmt::Debug;

pub(crate) type RedbPrimaryTableDefinition<'a> = redb::TableDefinition<'a, Key, &'static [u8]>;
pub(crate) type RedbSecondaryTableDefinition<'a> = redb::MultimapTableDefinition<'a, Key, Key>;

pub struct PrimaryTableDefinition<'a> {
    pub(crate) model: crate::Model,
    pub(crate) redb: RedbPrimaryTableDefinition<'a>,
    pub(crate) secondary_tables: HashMap<KeyDefinition<KeyOptions>, SecondaryTableDefinition<'a>>,
    pub(crate) native_model_options: NativeModelOptions,
}

#[derive(Clone, Debug, Default)]
pub struct NativeModelOptions {
    pub(crate) native_model_id: u32,
    pub(crate) native_model_version: u32,
    // If a model as a new version, the old version is still available but marked as legacy.
    // NOTE: Is impossible to write or read on a legacy table definition.
    //       Just a migration to a new version is allowed.
    pub(crate) native_model_legacy: bool,
}

impl<'a> From<(&ModelBuilder, RedbPrimaryTableDefinition<'a>)> for PrimaryTableDefinition<'a> {
    fn from(input: (&ModelBuilder, RedbPrimaryTableDefinition<'a>)) -> Self {
        let (builder, redb) = input;
        Self {
            model: builder.model.clone(),
            redb,
            secondary_tables: HashMap::new(),
            native_model_options: builder.native_model_options.clone(),
        }
    }
}

impl Debug for PrimaryTableDefinition<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        use redb::TableHandle;
        f.debug_struct("TableDefinition")
            .field("name", &self.redb.name())
            .field("model_id", &self.native_model_options.native_model_id)
            .field(
                "model_version",
                &self.native_model_options.native_model_version,
            )
            .field("legacy", &self.native_model_options.native_model_legacy)
            .finish()
    }
}

#[derive(Clone)]
pub(crate) struct SecondaryTableDefinition<'a> {
    pub(crate) redb: RedbSecondaryTableDefinition<'a>,
}

impl<'a> From<RedbSecondaryTableDefinition<'a>> for SecondaryTableDefinition<'a> {
    fn from(rdb: RedbSecondaryTableDefinition<'a>) -> SecondaryTableDefinition<'a> {
        Self { redb: rdb }
    }
}