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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
use schema::SchemaName;
use serde::{de::DeserializeOwned, Deserialize, Serialize};
use crate::{
connection::{AccessPolicy, Database, QueryKey},
document::Document,
kv::{KeyOperation, Output},
schema::{
self,
view::{self, map},
CollectionName, Key, MappedValue, ViewName,
},
transaction::{Executed, OperationResult, Transaction},
};
/// A payload with an associated id.
#[derive(Clone, Deserialize, Serialize, Debug)]
pub struct Payload<T> {
/// The unique id for this payload.
pub id: Option<u32>,
/// The wrapped payload.
pub wrapped: T,
}
/// A request made to a server.
#[derive(Clone, Deserialize, Serialize, Debug)]
#[cfg_attr(feature = "actionable-traits", derive(actionable::Actionable))]
pub enum Request<T> {
/// A server-related request.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "none"))]
Server(ServerRequest),
/// A database-related request.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "none"))]
Database {
/// The name of the database.
database: String,
/// The request made to the database.
request: DatabaseRequest,
},
/// A database-related request.
#[cfg_attr(
feature = "actionable-traits",
actionable(protection = "none", subaction)
)]
Api(T),
}
/// A server-related request.
#[derive(Clone, Deserialize, Serialize, Debug)]
#[cfg_attr(feature = "actionable-traits", derive(actionable::Actionable))]
pub enum ServerRequest {
/// Creates a database.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "simple"))]
CreateDatabase(Database),
/// Deletes the database named `name`
#[cfg_attr(feature = "actionable-traits", actionable(protection = "simple"))]
DeleteDatabase {
/// The name of the database to delete.
name: String,
},
/// Lists all databases.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "simple"))]
ListDatabases,
/// Lists available schemas.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "simple"))]
ListAvailableSchemas,
}
/// A database-related request.
#[derive(Clone, Deserialize, Serialize, Debug)]
#[cfg_attr(feature = "actionable-traits", derive(actionable::Actionable))]
pub enum DatabaseRequest {
/// Retrieve a single document.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "simple"))]
Get {
/// The collection of the document.
collection: CollectionName,
/// The id of the document.
id: u64,
},
/// Retrieve multiple documents.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "custom"))]
GetMultiple {
/// The collection of the documents.
collection: CollectionName,
/// The ids of the documents.
ids: Vec<u64>,
},
/// Queries a view.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "simple"))]
Query {
/// The name of the view.
view: ViewName,
/// The filter for the view.
key: Option<QueryKey<Vec<u8>>>,
/// The access policy for the query.
access_policy: AccessPolicy,
/// If true, [`DatabaseResponse::ViewMappingsWithDocs`] will be
/// returned. If false, [`DatabaseResponse::ViewMappings`] will be
/// returned.
with_docs: bool,
},
/// Reduces a view.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "simple"))]
Reduce {
/// The name of the view.
view: ViewName,
/// The filter for the view.
key: Option<QueryKey<Vec<u8>>>,
/// The access policy for the query.
access_policy: AccessPolicy,
/// Whether to return a single value or values grouped by unique key. If
/// true, [`DatabaseResponse::ViewGroupedReduction`] will be returned.
/// If false, [`DatabaseResponse::ViewReduction`] is returned.
grouped: bool,
},
/// Applies a transaction.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "custom"))]
ApplyTransaction {
/// The trasnaction to apply.
transaction: Transaction<'static>,
},
/// Lists executed transactions.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "simple"))]
ListExecutedTransactions {
/// The starting transaction id.
starting_id: Option<u64>,
/// The maximum number of results.
result_limit: Option<usize>,
},
/// Queries the last transaction id.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "simple"))]
LastTransactionId,
/// Creates a `PubSub` [`Subscriber`](crate::pubsub::Subscriber)
#[cfg_attr(feature = "actionable-traits", actionable(protection = "simple"))]
CreateSubscriber,
/// Publishes `payload` to all subscribers of `topic`.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "simple"))]
Publish {
/// The topics to publish to.
topic: String,
/// The payload to publish.
payload: Vec<u8>,
},
/// Publishes `payload` to all subscribers of all `topics`.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "custom"))]
PublishToAll {
/// The topics to publish to.
topics: Vec<String>,
/// The payload to publish.
payload: Vec<u8>,
},
/// Subscribes `subscriber_id` to messages for `topic`.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "simple"))]
SubscribeTo {
/// The id of the [`Subscriber`](crate::pubsub::Subscriber).
subscriber_id: u64,
/// The topic to subscribe to.
topic: String,
},
/// Unsubscribes `subscriber_id` from messages for `topic`.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "simple"))]
UnsubscribeFrom {
/// The id of the [`Subscriber`](crate::pubsub::Subscriber).
subscriber_id: u64,
/// The topic to unsubscribe from.
topic: String,
},
/// Unregisters the subscriber.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "none"))]
UnregisterSubscriber {
/// The id of the [`Subscriber`](crate::pubsub::Subscriber).
subscriber_id: u64,
},
/// Excutes a key-value store operation.
#[cfg_attr(feature = "actionable-traits", actionable(protection = "simple"))]
ExecuteKeyOperation(KeyOperation),
}
/// A response from a server.
#[derive(Clone, Serialize, Deserialize, Debug)]
pub enum Response<T> {
/// A request succeded but provided no output.
Ok,
/// A response to a [`ServerRequest`].
Server(ServerResponse),
/// A response to a [`DatabaseRequest`].
Database(DatabaseResponse),
/// A response to an Api request.
Api(T),
/// An error occurred processing a request.
Error(crate::Error),
}
/// A response to a [`ServerRequest`].
#[derive(Clone, Serialize, Deserialize, Debug)]
pub enum ServerResponse {
/// A database with `name` was successfully created.
DatabaseCreated {
/// The name of the database to create.
name: String,
},
/// A database with `name` was successfully removed.
DatabaseDeleted {
/// The name of the database to remove.
name: String,
},
/// A list of available databases.
Databases(Vec<Database>),
///A list of availble schemas.
AvailableSchemas(Vec<SchemaName>),
}
/// A response to a [`DatabaseRequest`].
#[derive(Clone, Serialize, Deserialize, Debug)]
pub enum DatabaseResponse {
/// One or more documents.
Documents(Vec<Document<'static>>),
/// Results of [`DatabaseRequest::ApplyTransaction`].
TransactionResults(Vec<OperationResult>),
/// Results of [`DatabaseRequest::Query`] when `with_docs` is false.
ViewMappings(Vec<map::Serialized>),
/// Results of [`DatabaseRequest::Query`] when `with_docs` is true.
ViewMappingsWithDocs(Vec<MappedDocument>),
/// Result of [`DatabaseRequest::Reduce`] when `grouped` is false.
ViewReduction(Vec<u8>),
/// Result of [`DatabaseRequest::Reduce`] when `grouped` is true.
ViewGroupedReduction(Vec<MappedValue<Vec<u8>, Vec<u8>>>),
/// Results of [`DatabaseRequest::ListExecutedTransactions`].
ExecutedTransactions(Vec<Executed<'static>>),
/// Result of [`DatabaseRequest::LastTransactionId`].
LastTransactionId(Option<u64>),
/// A new `PubSub` subscriber was created.
SubscriberCreated {
/// The unique ID of the subscriber.
subscriber_id: u64,
},
/// A PubSub message was received.
MessageReceived {
/// The ID of the subscriber receiving the message.
subscriber_id: u64,
/// The topic the payload was received on.
topic: String,
/// The message payload.
payload: Vec<u8>,
},
/// Output from a [`KeyOperation`] being executed.
KvOutput(Output),
}
/// A serialized [`MappedDocument`](map::MappedDocument).
#[derive(Clone, Serialize, Deserialize, Debug)]
pub struct MappedDocument {
/// The serialized key.
pub key: Vec<u8>,
/// The serialized value.
pub value: Vec<u8>,
/// The source document.
pub source: Document<'static>,
}
impl MappedDocument {
/// Deserialize into a [`MappedDocument`](map::MappedDocument).
pub fn deserialized<K: Key, V: Serialize + DeserializeOwned>(
self,
) -> Result<map::MappedDocument<K, V>, crate::Error> {
let key = Key::from_big_endian_bytes(&self.key).map_err(|err| {
crate::Error::Database(view::Error::KeySerialization(err).to_string())
})?;
let value = serde_cbor::from_slice(&self.value)
.map_err(|err| crate::Error::Database(view::Error::from(err).to_string()))?;
Ok(map::MappedDocument {
document: self.source,
key,
value,
})
}
}
/// A networking error.
#[derive(Clone, thiserror::Error, Debug, Serialize, Deserialize)]
pub enum Error {
/// The server responded with a message that wasn't expected for the request
/// sent.
#[error("unexpected response: {0}")]
UnexpectedResponse(String),
/// The connection was interrupted.
#[error("unexpected disconnection")]
Disconnected,
}