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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
use std::fmt::Debug;
use std::hash::Hash;
use std::time::Duration;
use log::LevelFilter;
use serde::de::DeserializeOwned;
use serde::Serialize;
pub mod memory;
pub mod normal;
#[derive(Debug, Clone)]
pub struct ClientConfig
{
/// The path to the database file.
///
/// Default: "db.qkv"
pub path: Option<String>,
/// If the database should log to stdout.
///
/// Default: true
pub log: Option<bool>,
/// The log level to use for the database.
///
/// Default: LevelFilter::Info
pub log_level: Option<LevelFilter>,
/// The default time-to-live for entries in the database.
///
/// If enabled, all entries will have a ttl by default.
/// If disabled (None), then you will have to manually set the ttl for each entry.
///
/// Default: None
pub default_ttl: Option<Duration>,
}
impl ClientConfig
{
pub fn new(path: String, log: Option<bool>, log_level: Option<LevelFilter>) -> Self
{
Self {
path: Some(path),
log,
log_level,
default_ttl: None,
}
}
}
impl Default for ClientConfig
{
fn default() -> Self
{
Self {
path: "db.qkv".to_string().into(),
log: true.into(),
log_level: LevelFilter::Info.into(),
default_ttl: None,
}
}
}
pub trait BaseClient<T>
where
T: Serialize + DeserializeOwned + Debug + Eq + PartialEq + Hash + Send + Sync,
{
/// Creates a new instance of the client.
///
/// `config` is the configuration for the database. If `None`, then the default configuration will be used.
///
/// The client needs to know what type of data it will be storing, so it can properly serialize and deserialize it.
/// You need to specify the type of data when creating a new client using the `client::<T>::new()` method.
///
/// This type must implement the following traits:
/// - `Serialize`
/// - `DeserializeOwned`
/// - `Debug`
/// - `Eq`
/// - `PartialEq`
/// - `Hash`
/// - `Send`
/// - `Sync`
/// - `Clone`
///
/// # Examples
/// *With default configuration:*
/// ```rust
/// use quick_kv::prelude::*;
///
/// #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
/// struct Schema
/// {
/// id: u64,
/// };
///
/// let mut client = QuickClient::<Schema>::new(ClientConfig::new(
/// "db.qkv".to_string(),
/// true.into(),
/// LevelFilter::Debug.into(),
/// ));
/// ```
fn new(config: ClientConfig) -> Self;
/// Get the value associated with a key.
///
/// Returns `None` if the key does not exist. This could be caused by
/// the key never being assigned a value, or the key expiring.
///
/// # Examples
/// ```rust
/// use quick_kv::prelude::*;
///
/// #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
/// struct Schema
/// {
/// id: u64,
/// }
///
/// let mut client = QuickClient::<Schema>::new(ClientConfig::new(
/// "db.qkv".to_string(),
/// true.into(),
/// LevelFilter::Debug.into(),
/// ));
///
/// client.set("user_1", Schema { id: 10 }).unwrap();
///
/// let user = client.get("user_1").unwrap();
///
/// // do something with the user
/// ```
/// Do something with the result. After Consuming the result, you
/// must handle the `Option<T>` that is returned.
fn get(&mut self, key: &str) -> anyhow::Result<Option<T>>;
/// Set the value associated with a key.
///
/// If the key already exists, the database will attempt to overwrite the value.
///
/// `key` to set the value for.
///
/// `value` to set for the key.
///
/// `ttl` the time-to-live for the key. If `None`, then the the key will not expire,
/// unless `default_ttl` is set in the configuration. If `default_ttl` is set, then
/// the key will expire after the default ttl. If ttl is set here, it will override
/// the default ttl set in the configuration.
///
/// # Examples
/// ```rust
/// use quick_kv::prelude::*;
///
/// #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
/// struct Schema
/// {
/// id: u64,
/// };
///
/// let mut client = QuickClient::<Schema>::new(ClientConfig::new(
/// "db.qkv".to_string(),
/// true.into(),
/// LevelFilter::Debug.into(),
/// ));
///
/// client.set("user_1", Schema { id: 10 }).unwrap();
/// ```
fn set(&mut self, key: &str, value: T) -> anyhow::Result<()>;
/// Update the value associated with a key.
///
/// By default update will fail if the key does not exist. If you want to upsert the value, then
/// you can set `upsert` to `true` using `true.into()` or `Some(true)`.
///
/// `key` to update the value for.
///
/// `value` to update for the key.
///
/// `upsert` if the value should be upserted if the key does not exist.
///
/// # Examples
/// ```rust
/// use quick_kv::prelude::*;
///
/// #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
/// struct Schema
/// {
/// id: u64,
/// };
///
/// let mut client = QuickClient::<Schema>::new(ClientConfig::new(
/// "db.qkv".to_string(),
/// true.into(),
/// LevelFilter::Debug.into(),
/// ));
///
/// client.update("user_1", Schema { id: 10 }, None).unwrap(); // fails
/// client
/// .update("user_1", Schema { id: 20 }, true.into())
/// .unwrap(); // succeeds
/// ```
fn update(&mut self, key: &str, value: T, upsert: Option<bool>) -> anyhow::Result<()>;
/// Delete the value associated with a key.
///
/// `key` to delete the value for.
///
/// # Examples
/// ```rust
/// use quick_kv::prelude::*;
///
/// #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
/// struct Schema
/// {
/// id: u64,
/// };
///
/// let mut client = QuickClient::<Schema>::new(ClientConfig::new(
/// "db.qkv".to_string(),
/// true.into(),
/// LevelFilter::Debug.into(),
/// ));
///
/// client.delete("user_1").unwrap();
/// ```
fn delete(&mut self, key: &str) -> anyhow::Result<()>;
/// Check if a key exists in the database.
///
/// `key` to check if it exists.
///
/// # Examples
/// ```rust
/// use quick_kv::prelude::*;
///
/// #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
/// struct Schema
/// {
/// id: u64,
/// };
///
/// let mut client = QuickClient::<Schema>::new(ClientConfig::new(
/// "db.qkv".to_string(),
/// true.into(),
/// LevelFilter::Debug.into(),
/// ));
///
/// if client.exists("user_1").unwrap() {
/// // do something
/// }
/// ```
fn exists(&mut self, key: &str) -> anyhow::Result<bool>;
/// Get all keys in the database.
///
/// Returns `None` if there are no keys in the database or a `Vec<String>` keys.
///
/// # Examples
/// ```rust
/// use quick_kv::prelude::*;
///
/// #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
/// struct Schema
/// {
/// id: u64,
/// };
///
/// let mut client = QuickClient::<Schema>::new(ClientConfig::new(
/// "db.qkv".to_string(),
/// true.into(),
/// LevelFilter::Debug.into(),
/// ));
///
/// let all_keys = client.keys().unwrap();
/// ```
fn keys(&mut self) -> anyhow::Result<Option<Vec<String>>>;
/// Get all values in the database.
///
/// Returns `None` if there are no values in the database or a `Vec<T>` values.
///
/// # Examples
/// ```rust
/// use quick_kv::prelude::*;
///
/// #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
/// struct Schema
/// {
/// id: u64,
/// };
///
/// let mut client = QuickClient::<Schema>::new(ClientConfig::new(
/// "db.qkv".to_string(),
/// true.into(),
/// LevelFilter::Debug.into(),
/// ));
///
/// let all_values = client.values().unwrap();
/// ```
fn values(&mut self) -> anyhow::Result<Option<Vec<T>>>;
/// Get the number of keys in the database.
///
/// Returns `0` if there are no keys in the database or the number of keys in the database.
///
/// # Examples
/// ```rust
/// use quick_kv::prelude::*;
///
/// #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
/// struct Schema
/// {
/// id: u64,
/// };
///
/// let mut client = QuickClient::<Schema>::new(ClientConfig::new(
/// "db.qkv".to_string(),
/// true.into(),
/// LevelFilter::Debug.into(),
/// ));
///
/// let num_keys = client.len().unwrap();
/// ```
fn len(&mut self) -> anyhow::Result<usize>;
/// Clears all keys and values from the database.
/// # Examples
/// ```rust
/// use quick_kv::prelude::*;
///
/// #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
/// struct Schema
/// {
/// id: u64,
/// };
///
/// let mut client = QuickClient::<Schema>::new(ClientConfig::new(
/// "db.qkv".to_string(),
/// true.into(),
/// LevelFilter::Debug.into(),
/// ));
///
/// client.purge().unwrap();
/// ```
fn purge(&mut self) -> anyhow::Result<()>;
/// Get multiple values associated with multiple keys.
/// # Examples
/// ```rust
/// use quick_kv::prelude::*;
///
/// #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
/// struct Schema
/// {
/// id: u64,
/// };
///
/// let mut client = QuickClient::<Schema>::new(ClientConfig::new(
/// "db.qkv".to_string(),
/// true.into(),
/// LevelFilter::Debug.into(),
/// ));
///
/// let values = client.get_many(&["user_1", "user_2"]).unwrap();
/// ```
fn get_many(&mut self, keys: &[&str]) -> anyhow::Result<Option<Vec<T>>>;
/// Set multiple values associated with multiple keys.
///
/// # Examples
/// ```rust
/// use quick_kv::prelude::*;
///
/// #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
/// struct Schema
/// {
/// id: u64,
/// };
///
/// let mut client = QuickClient::<Schema>::new(ClientConfig::new(
/// "db.qkv".to_string(),
/// true.into(),
/// LevelFilter::Debug.into(),
/// ));
///
/// client
/// .set_many(
/// &["user_1", "user_2"],
/// &[Schema { id: 10 }, Schema { id: 20 }],
/// )
/// .unwrap();
/// ```
fn set_many(&mut self, keys: &[&str], values: &[T]) -> anyhow::Result<()>;
/// Delete multiple values associated with multiple keys.
///
/// # Examples
/// ```rust
/// use quick_kv::prelude::*;
///
/// #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
/// struct Schema
/// {
/// id: u64,
/// };
///
/// let mut client = QuickClient::<Schema>::new(ClientConfig::new(
/// "db.qkv".to_string(),
/// true.into(),
/// LevelFilter::Debug.into(),
/// ));
///
/// client.delete_many(&["user_1", "user_2"]).unwrap();
/// ```
fn delete_many(&mut self, keys: &[&str]) -> anyhow::Result<()>;
/// Update multiple values associated with multiple keys.
///
/// # Examples
/// ```rust
/// use quick_kv::prelude::*;
///
/// #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
/// struct Schema {
/// id: u64,
/// };
///
/// let mut client = QuickClient::<Schema>::new(ClientConfig::new("db.qkv".to_string(), true.into(), LevelFilter::Debug.into()));
///
/// client.update_many(&["user_1", "user_2"], &[Schema { id: 10 }, Schema { id: 20 }], true.into()).unwrap();
fn update_many(&mut self, keys: &[&str], values: &[T], upsert: Option<bool>) -> anyhow::Result<()>;
}