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
/// Joins Data of different `Tables` in the Database together
///
/// ```
/// use light_magic::{
/// atomic::DataStore,
/// join,
/// serde::{Deserialize, Serialize},
/// table::{PrimaryKey, Table},
/// };
///
/// #[derive(Default, Debug, Serialize, Deserialize)]
/// struct Database {
/// user: Table<User>,
/// criminal: Table<Criminal>,
/// }
///
/// impl DataStore for Database {}
///
/// #[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)]
/// struct User {
/// id: usize,
/// name: String,
/// kind: String,
/// }
///
/// impl PrimaryKey for User {
/// type PrimaryKeyType = usize;
///
/// fn primary_key(&self) -> &Self::PrimaryKeyType {
/// &self.id
/// }
/// }
///
/// #[derive(Default, Debug, Clone, Serialize, Deserialize)]
/// struct Criminal {
/// user_name: String,
/// entry: String,
/// }
///
/// impl PrimaryKey for Criminal {
/// type PrimaryKeyType = String;
///
/// fn primary_key(&self) -> &Self::PrimaryKeyType {
/// &self.user_name
/// }
/// }
///
/// let db = Database::open_in_memory();
/// // Firstly specify the Database which should be used, then the key,
/// // and lastly the joined items with the field which will be compared with the key
/// let joined = join!(db.read(), "Nils", user => name, criminal => user_name);
/// ```