entropy-kvdb 0.4.0

Encrypted key-value database for the Entropy Theshold Signing Server
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

// Copyright (C) 2023 Entropy Cryptography Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

//! useful types and default paths for the kv_manager

use std::fmt::Debug;

// default KV store names
pub const DEFAULT_KV_NAME: &str = "kv";

/// default path of kv store
/// the full name of the kv store is "DEFAULT_KV_PATH/kv_name"
pub(super) const DEFAULT_KV_PATH: &str = "kvstore";

/// default value for reserved key
pub(super) const DEFAULT_RESERVE: &str = "";

/// Returned from a successful `ReserveKey` command
#[derive(Debug)] // disallow derive Clone, Copy
pub struct KeyReservation {
    pub key: String,
}
/// kv store needs PartialEq to complare values
impl PartialEq for KeyReservation {
    fn eq(&self, other: &Self) -> bool {
        self.key == other.key
    }
}

// Provided by the requester and used by the manager task to send the command response back to the
// requester.
type Responder<T> = tokio::sync::oneshot::Sender<super::error::InnerKvResult<T>>;

#[derive(Debug)]
pub(super) enum Command<V> {
    ReserveKey {
        key: String,
        resp: Responder<KeyReservation>,
    },
    UnreserveKey {
        reservation: KeyReservation,
    },
    Put {
        reservation: KeyReservation,
        value: V,
        resp: Responder<()>,
    },
    Get {
        key: String, // TODO should be &str except lifetimes...
        resp: Responder<V>,
    },
    Exists {
        key: String, // TODO should be &str except lifetimes...
        resp: Responder<bool>,
    },
    Delete {
        key: String,
        resp: Responder<()>,
    },
}