ents 0.5.1

Minimal entity framework
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

mod edge_provider;
mod query_edge;

use std::{any::Any, borrow::BorrowMut};

pub use edge_provider::{
    check_incoming_edges, DraftError, EdgeDraft, EdgeValue,
    IncomingEdgeProvider, IncomingEdgeValue, NullEdgeDraft, NullEdgeProvider,
};
pub use query_edge::{
    Edge, EdgeCursor, EdgeQuery, EdgeQueryResult, QueryEdge, SortOrder,
};

/// Unique identifier for an entity
pub type Id = u64;

pub trait ReadEnt: QueryEdge {
    fn get(&self, id: Id) -> Result<Option<Box<dyn Ent>>, DatabaseError>;
}

pub trait Transactional: ReadEnt {
    fn create<E: Ent>(&self, ent: E) -> Result<Id, DatabaseError>;

    fn delete(&self, id: Id) -> Result<(), DatabaseError>;

    fn create_edge(&self, edge: EdgeValue) -> Result<(), DatabaseError>;

    fn update<T, F, B>(
        &self,
        ent: B,
        mutator: F,
    ) -> Result<bool, DatabaseError>
    where
        T: Ent,
        F: FnOnce(&mut T),
        B: BorrowMut<T>;

    fn commit(self) -> Result<(), DatabaseError>;
}

pub trait TransactionProvider: 'static + Clone {
    type Tx<'a>: Transactional;

    fn execute<R, F>(&self, func: F) -> Result<R, DatabaseError>
    where
        F: for<'a> FnOnce(Self::Tx<'a>) -> R;
}

/// Error type for database operations
#[derive(Debug, thiserror::Error)]
pub enum DatabaseError {
    #[error("Entity capacity reached")]
    EntCapacityReached,
    #[error("Other error: {source}")]
    Other {
        #[from]
        source: Box<dyn std::error::Error + Send + Sync>,
    },
}

pub type DatabaseResult<T> = Result<T, DatabaseError>;

/// Error type for entity mutations
#[derive(Debug, thiserror::Error)]
pub enum EntMutationError {
    #[error("Other error: {0}")]
    Other(String),
}

#[typetag::serde(tag = "type")]
pub trait Ent: Any + dyn_clone::DynClone + Send + Sync {
    type EdgeProvider: IncomingEdgeProvider<Self>
    where
        Self: Sized;

    fn id(&self) -> Id;
    fn set_id(&mut self, id: Id);
    fn last_updated(&self) -> u64;
    fn mark_updated(&mut self) -> Result<(), EntMutationError>;

    fn setup_edges<T: Transactional>(&self, txn: &T) -> Result<(), DraftError>
    where
        Self: Sized,
    {
        for edge in check_incoming_edges(self, txn)? {
            txn.create_edge(edge)?;
        }
        Ok(())
    }
}

dyn_clone::clone_trait_object!(Ent);

pub trait EntExt {
    fn is<T: Ent>(&self) -> bool;

    fn as_ent<T: Ent>(&self) -> Option<&T>;

    fn as_ent_mut<T: Ent>(&mut self) -> Option<&mut T>;

    fn downcast_ent<T: Ent>(self) -> Option<Box<T>>;

    fn into_ent<T: Ent>(self) -> Option<T>
    where
        Self: Sized,
    {
        self.downcast_ent().map(|x| *x)
    }
}

impl EntExt for Box<dyn Ent> {
    fn is<T: Ent>(&self) -> bool {
        (&**self as &dyn Any).is::<T>()
    }

    fn as_ent<T: Ent>(&self) -> Option<&T> {
        (&**self as &dyn Any).downcast_ref::<T>()
    }

    fn as_ent_mut<T: Ent>(&mut self) -> Option<&mut T> {
        (&mut **self as &mut dyn Any).downcast_mut::<T>()
    }

    fn downcast_ent<T: Ent>(self) -> Option<Box<T>> {
        (self as Box<dyn Any>).downcast::<T>().ok()
    }
}