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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
use super::*;

/// # Arguments
///
/// * `index`:
/// * `data`:
///
/// returns: Result<<Self::Provider as ValueProvider>::ValueRef, GraphError>
///
/// # Examples
///
/// ```
/// use graph_types::{EntryEngine, GraphEngine, ListStorage};
/// ```
pub trait ValueProvider<'a, V>: Send + Sync {
    /// # Arguments
    ///
    /// * `index`:
    /// * `data`:
    ///
    /// returns: Result<<Self::Provider as ValueProvider>::ValueRef, GraphError>
    ///
    /// # Examples
    ///
    /// ```
    /// use graph_types::{EntryEngine, GraphEngine, ListStorage};
    /// ```
    type ValueRef: Deref<Target = V>;
    /// # Arguments
    ///
    /// * `index`:
    /// * `data`:
    ///
    /// returns: Result<<Self::Provider as ValueProvider>::ValueRef, GraphError>
    ///
    /// # Examples
    ///
    /// ```
    /// use graph_types::{EntryEngine, GraphEngine, ListStorage};
    /// ```
    type ValueMut: DerefMut<Target = V>;
    /// # Arguments
    ///
    /// * `index`:
    /// * `data`:
    ///
    /// returns: Result<<Self::Provider as ValueProvider>::ValueRef, GraphError>
    ///
    /// # Examples
    ///
    /// ```
    /// use graph_types::{EntryEngine, GraphEngine, ListStorage};
    /// ```
    fn get_value(&'a self, query: Query) -> Result<Self::ValueRef, GraphError>;
    /// # Arguments
    ///
    /// * `index`:
    /// * `data`:
    ///
    /// returns: Result<<Self::Provider as ValueProvider>::ValueRef, GraphError>
    ///
    /// # Examples
    ///
    /// ```
    /// use graph_types::{EntryEngine, GraphEngine, ListStorage};
    /// ```
    fn mut_value(&'a mut self, query: Query) -> Result<Self::ValueMut, GraphError>;
    /// # Arguments
    ///
    /// * `index`:
    /// * `data`:
    ///
    /// returns: Result<<Self::Provider as ValueProvider>::ValueRef, GraphError>
    ///
    /// # Examples
    ///
    /// ```
    /// use graph_types::{EntryEngine, GraphEngine, ListStorage};
    /// ```
    fn set_value(&'a mut self, query: Query, value: V) -> Result<V, GraphError> {
        let mut new = value;
        let mut old = self.mut_value(query)?;
        std::mem::swap(&mut new, &mut old);
        Ok(new)
    }
}

/// A graph that has extra data associated with each node and edge.
///
/// # Arguments
///
/// * `index`:
/// * `data`:
///
/// returns: Result<<Self::Provider as ValueProvider>::ValueRef, GraphError>
///
/// # Examples
///
/// ```
/// use graph_types::{EntryEngine, GraphEngine, ListStorage};
/// ```
pub trait EntryEngine<V>: GraphEngine {
    /// # Arguments
    ///
    /// * `index`:
    /// * `data`:
    ///
    /// returns: Result<<Self::Provider as ValueProvider>::ValueRef, GraphError>
    ///
    /// # Examples
    ///
    /// ```
    /// use graph_types::{EntryEngine, GraphEngine, ListStorage};
    /// ```
    type Provider: for<'p> ValueProvider<'p, V>;

    /// # Arguments
    ///
    /// * `index`:
    /// * `data`:
    ///
    /// returns: Result<<Self::Provider as ValueProvider>::ValueRef, GraphError>
    ///
    /// # Examples
    ///
    /// ```
    /// use graph_types::{EntryEngine, GraphEngine, ListStorage};
    /// ```
    fn get_data<'a, 'p>(
        &'a self,
        data: &'p Self::Provider,
        query: Query,
    ) -> Result<<Self::Provider as ValueProvider<'p, V>>::ValueRef, GraphError> {
        data.get_value(query)
    }
    /// # Arguments
    ///
    /// * `index`:
    /// * `data`:
    ///
    /// returns: Result<<Self::Provider as ValueProvider>::ValueRef, GraphError>
    ///
    /// # Examples
    ///
    /// ```
    /// use graph_types::{EntryEngine, GraphEngine, ListStorage};
    /// ```
    fn mut_data(&self, data: &mut Self::Provider, query: Query, value: V) -> Result<V, GraphError> {
        data.set_value(query, value)
    }
    /// # Arguments
    ///
    /// * `index`:
    /// * `data`:
    ///
    /// returns: Result<<Self::Provider as ValueProvider>::ValueRef, GraphError>
    ///
    /// # Examples
    ///
    /// ```
    /// use graph_types::{EntryEngine, GraphEngine, ListStorage};
    /// ```
    fn async_get_data<'a, 'p, 'async_trait>(
        &'a self,
        data: &'p Self::Provider,
        query: Query,
    ) -> Pin<
        Box<dyn Future<Output = Result<<Self::Provider as ValueProvider<'p, V>>::ValueRef, GraphError>> + Send + 'async_trait>,
    >
    where
        'a: 'async_trait,
        'p: 'async_trait,
        V: Send + 'async_trait,
        Self: Sync + 'async_trait,
    {
        Box::pin(async move { data.get_value(query) })
    }
    /// # Arguments
    ///
    /// * `index`:
    /// * `data`:
    ///
    /// returns: Result<<Self::Provider as ValueProvider>::ValueRef, GraphError>
    ///
    /// # Examples
    ///
    /// ```
    /// use graph_types::{EntryEngine, GraphEngine, ListStorage};
    /// ```
    fn async_mut_data<'a, 'p, 'async_trait>(
        &'a self,
        data: &'p mut Self::Provider,
        query: Query,
        value: V,
    ) -> Pin<Box<dyn Future<Output = Result<V, GraphError>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        'p: 'async_trait,
        V: Send + 'async_trait,
        Self: Sync + 'async_trait,
    {
        Box::pin(async move { data.set_value(query, value) })
    }
}