cape 0.0.2

🦸 An unintrusive ORM for Rust
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

use std::marker::PhantomData;
use std::ops::Not;

use crate::id::Id;
use crate::inner::Inner;
use crate::persistence::{N, Persistence, S};
use crate::timestamp::Timestamp;

/// A record wraps a domain object `T` with metadata and relations.
///
/// - `R`: relations (another Record, or tuple, or Vec<Record<_>>)
/// - `S`: persistence state (N, S)
/// - `K`: key type (i64, Uuid, ...)
#[derive(Debug, Clone)]
pub struct Record<T, R = (), S: Persistence = N, K = i64>
where
    T: Inner,
    R: Inner,
    K: Clone,
{
    // None for N, Some(K) for S
    id: Option<Id<K>>,

    pub inner: T,

    pub relations: R,

    created_at: Option<Timestamp>,

    updated_at: Option<Timestamp>,

    _dirty: bool,
    _state: PhantomData<S>,
}

/// Common implementation for all records
impl<T, R, S, K> Record<T, R, S, K>
where
    T: Inner,
    R: Inner,
    S: Persistence,
    K: Clone,
{
    pub fn is_dirty(&self) -> bool {
        self._dirty
    }

    pub fn mark_dirty(&mut self) {
        self._dirty = true;
    }
}

/// Implementation for records with persistence state N (New)
impl<T, K> Record<T, (), N, K>
where
    T: Inner,
    K: Inner,
{
    pub fn new(inner: T) -> Self {
        Self {
            id: None,
            inner,
            relations: (),
            created_at: None,
            updated_at: None,
            _dirty: true,
            _state: PhantomData,
        }
    }

    pub fn with_relations<R>(inner: T, relations: R) -> Record<T, R, N>
    where
        R: Inner,
    {
        Record {
            id: None,
            inner,
            relations,
            created_at: None,
            updated_at: None,
            _dirty: true,
            _state: PhantomData,
        }
    }
}

/// Implementation for records with persistence state N (New)
impl<T, K, R> Record<T, R, N, K>
where
    T: Inner,
    R: Inner,
    K: Clone,
{
    pub fn store(self, id: K, created_at: Timestamp) -> Record<T, R, S, K> {
        Record {
            id: Some(Id::new(id)),
            inner: self.inner,
            relations: self.relations,
            created_at: Some(created_at),
            updated_at: Some(created_at),
            _dirty: false,
            _state: PhantomData,
        }
    }
}

/// Implementation for records with persistence state S (Stored)
impl<T, K, R> Record<T, R, S, K>
where
    T: Inner,
    R: Inner,
    K: Clone,
{
    pub fn id(&self) -> &K {
        self.id
            .as_ref()
            .and_then(|id| id.get())
            .expect("stored record must have an id")
    }

    pub fn created_at(&self) -> &Timestamp {
        self.created_at
            .as_ref()
            .expect("stored record must have a created_at timestamp")
    }

    pub fn updated_at(&self) -> &Timestamp {
        self.updated_at
            .as_ref()
            .expect("stored record must have an updated_at timestamp")
    }

    pub fn store(self, id: K, created_at: Timestamp) -> Record<T, R, S, K> {
        if self._dirty.not() {
            return self;
        }

        Record {
            id: Some(Id::new(id)),
            inner: self.inner,
            relations: self.relations,
            created_at: Some(created_at),
            updated_at: Some(created_at),
            _dirty: false,
            _state: PhantomData,
        }
    }
}