armour 0.30.27

DDL and serialization for key-value storage
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

use std::fmt::Debug;

use const_fnv1a_hash::fnv1a_hash_str_32;

use crate::{
    Cid, GetType, KeyScheme, Typ,
    types::{ArmourError, EntityAttribute},
};

pub enum MigrationRes<Item: Record> {
    /// value unchanged
    Unchanged(Item::SelfId, Item),
    /// value changed
    Changed {
        migration_type: MigrationType,
        new_key: Item::SelfId,
        new_value: Item,
    },
    /// value deleted
    Deleted,
}

/// migration fn (key, value)
pub type MigrationFn<Item, Val> = fn(&[u8], &Val) -> MigrationRes<Item>;

#[derive(Debug, Clone, Copy)]
pub enum MigrationType {
    /// only key changed
    Key,
    /// only value changed
    Value,
    /// both key and value changed
    Entry,
}

/// (version, migration fn)
/// - version, for which migration is applied
/// - migration_fn: fn(key, value) -> MigrationRes
pub type Migration<Item, Val> = (u16, MigrationFn<Item, Val>);

pub trait Record: Sized + GetType + 'static {
    type SelfId: Cid + Debug;
    type Value: Debug + Clone;
    const NAME: &'static str;
    const ID: u32 = fnv1a_hash_str_32(Self::NAME);
    /// actual version, increment version on schema change
    const VERSION: u16 = 0;
    /// migrations (version, migration_fn)
    /// - version saved in db, for which migration is applied (if equal, migration_fn called)
    /// - migration_fn: fn(key, value) -> MigrationRes
    const MIGRATIONS: &'static [Migration<Self, Self::Value>] = &[];
    const ATTRIBUTES: EntityAttribute = EntityAttribute::from_ty::<Self>();
    /// static size of the record, if known
    const SIZE: Option<usize> = None;

    fn deser(bytes: &Self::Value) -> Self;

    fn deser_owned(bytes: Self::Value) -> Self {
        Self::deser(&bytes)
    }

    fn try_deser(bytes: &Self::Value) -> Result<Self, ArmourError> {
        Ok(Self::deser(bytes))
    }

    fn ser(&self) -> Self::Value;

    fn ser_owned(self) -> Self::Value {
        Self::ser(&self)
    }

    #[inline]
    fn deser_key(key: &[u8]) -> Self::SelfId {
        <Self as Record>::SelfId::from_bytes(key).expect("cannot deserialize key")
    }

    #[inline]
    fn try_deser_key(key: &[u8]) -> Result<Self::SelfId, ArmourError> {
        <Self as Record>::SelfId::from_bytes(key)
    }
}

pub const fn record_types_tuple<R>() -> (KeyScheme, Typ)
where
    R: Record + GetType,
{
    let key_type = R::SelfId::TY;
    let val_type = R::TYPE;
    (key_type, val_type)
}