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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229

/// `TreeDatabase`
mod tree;

/// `VecDatabase`
mod vec;

pub use tree::TreeDatabase;
pub use vec::VecDatabase;

/// Interface for working with databases
pub trait Database<M>: Default {
    type PositionKey: Copy;

    /// Push raw message to database
    ///
    /// ```
    /// use spartan_lib::core::db::Database;
    /// use spartan_lib::core::db::VecDatabase;
    /// use spartan_lib::core::message::builder::MessageBuilder;
    ///
    /// let mut db = VecDatabase::default();
    /// let message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// db.push_raw(message);
    /// ```
    fn push_raw(&mut self, message: M);

    /// Get database position key of the first message, that matches predicate
    ///
    /// ```
    /// use spartan_lib::core::db::Database;
    /// use spartan_lib::core::db::VecDatabase;
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::Dispatchable;
    ///
    /// let mut db = VecDatabase::default();
    /// let message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// db.push_raw(message);
    ///
    /// assert_eq!(db.position(|msg| msg.obtainable()).unwrap(), 0);
    /// ```
    fn position<F>(&self, predicate: F) -> Option<Self::PositionKey>
    where
        F: Fn(&M) -> bool;

    /// Get shared message reference by database position key
    ///
    /// ```
    /// use spartan_lib::core::db::Database;
    /// use spartan_lib::core::db::VecDatabase;
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::Dispatchable;
    ///
    /// let mut db = VecDatabase::default();
    /// let message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// db.push_raw(message);
    ///
    /// let position = db.position(|msg| msg.obtainable()).unwrap();
    ///
    /// assert!(db.get(position).unwrap().obtainable());
    /// ```
    fn get(&self, position: Self::PositionKey) -> Option<&M>;

    /// Get mutable message reference by database position key
    ///
    /// ```
    /// use spartan_lib::core::db::Database;
    /// use spartan_lib::core::db::VecDatabase;
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::{Dispatchable, Status};
    ///
    /// let mut db = VecDatabase::default();
    /// let message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// db.push_raw(message);
    ///
    /// let position = db.position(|msg| msg.obtainable()).unwrap();
    ///
    /// db.get_mut(position).unwrap().reserve();
    /// ```
    fn get_mut(&mut self, position: Self::PositionKey) -> Option<&mut M>;

    /// Delete message by database position key
    ///
    /// Returns owned message if position key is present in database
    ///
    /// ```
    /// use spartan_lib::core::db::Database;
    /// use spartan_lib::core::db::VecDatabase;
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::Dispatchable;
    ///
    /// let mut db = VecDatabase::default();
    /// let message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// db.push_raw(message);
    ///
    /// let position = db.position(|msg| msg.obtainable()).unwrap();
    ///
    /// db.delete_pos(position).unwrap();
    /// ```
    fn delete_pos(&mut self, position: Self::PositionKey) -> Option<M>;

    /// Retain only messages, that match predicate
    ///
    /// ```
    /// use spartan_lib::core::db::Database;
    /// use spartan_lib::core::db::VecDatabase;
    ///
    /// let mut db = VecDatabase::default();
    ///
    /// db.push_raw(1);
    /// db.push_raw(2);
    /// db.push_raw(3);
    ///
    /// db.retain(|msg| *msg == 1 || *msg == 2);
    ///
    /// assert_eq!(db.position(|msg| *msg == 2).unwrap(), 1);
    /// ```
    fn retain<F>(&mut self, predicate: F)
    where
        F: Fn(&M) -> bool;

    /// Get database size
    ///
    /// ```
    /// use spartan_lib::core::db::Database;
    /// use spartan_lib::core::db::VecDatabase;
    ///
    /// let mut db = VecDatabase::default();
    ///
    /// db.push_raw(1);
    /// db.push_raw(2);
    /// db.push_raw(3);
    ///
    /// assert_eq!(db.len(), 3);
    /// ```
    fn len(&self) -> usize;

    /// Check if database is empty
    ///
    /// ```
    /// use spartan_lib::core::db::Database;
    /// use spartan_lib::core::db::VecDatabase;
    ///
    /// let mut db = VecDatabase::default();
    ///
    /// db.push_raw(1);
    ///
    /// assert!(!db.is_empty());
    /// ```
    fn is_empty(&self) -> bool;

    /// Remove all database messages
    ///
    /// ```
    /// use spartan_lib::core::db::Database;
    /// use spartan_lib::core::db::VecDatabase;
    ///
    /// let mut db = VecDatabase::default();
    ///
    /// db.push_raw(1);
    ///
    /// db.clear();
    ///
    /// assert!(db.is_empty());
    /// ```
    fn clear(&mut self);
}

/// Interface for working with databases, that support status interaction
pub trait StatusAwareDatabase<M>: Database<M> {
    type RequeueKey: Copy;

    /// Reserve message in database
    ///
    /// Removes message from tree in `TreeDatabase`, does nothing in `VecDatabase`
    ///
    /// ```
    /// use spartan_lib::core::db::{Database, StatusAwareDatabase};
    /// use spartan_lib::core::db::TreeDatabase;
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::{Dispatchable, Status};
    ///
    /// let mut db = TreeDatabase::default();
    /// let message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// db.push_raw(message);
    ///
    /// let position = db.position(|msg| msg.reservable()).unwrap();
    ///
    /// // reserve returns mutable reference to message, so we can call reserve on message too.
    /// let message = db.reserve(position).unwrap();
    /// message.reserve();
    /// ```
    fn reserve(&mut self, position: Self::PositionKey) -> Option<&mut M>;

    /// Requeue message back to database
    ///
    /// Returns message back to tree in `TreeDatabase`, does nothing in `VecDatabase`
    ///
    /// ```
    /// use spartan_lib::core::db::{Database, StatusAwareDatabase};
    /// use spartan_lib::core::db::TreeDatabase;
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::{Dispatchable, Status, Identifiable};
    ///
    /// let mut db = TreeDatabase::default();
    /// let message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// db.push_raw(message);
    ///
    /// let position = db.position(|msg| msg.reservable()).unwrap();
    ///
    /// let message = db.reserve(position).unwrap();
    /// message.reserve();
    ///
    /// let id = message.id();
    ///
    /// // requeue tries to find a message with provided id, and checks it for predicate
    /// let message = db.requeue(id, |msg| msg.requeueable()).unwrap();
    /// message.requeue();
    /// ```
    fn requeue<F>(&mut self, position: Self::RequeueKey, predicate: F) -> Option<&mut M>
    where
        F: Fn(&M) -> bool;
}