cortexkit-bus-trait 0.3.1

NATS-shaped message-plane traits and backend conformance contract
Documentation 
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

use async_trait::async_trait;

use crate::BusResult;

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Revision(pub u64);

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RegisterValue {
    pub value: Vec<u8>,
    pub revision: Revision,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RegisterEntry {
    pub key: String,
    pub value: Vec<u8>,
    pub revision: Revision,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Tombstone {
    pub key: String,
    pub revision: Revision,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum RegisterUpdate {
    Put(RegisterEntry),
    Delete(Tombstone),
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum WatchEvent {
    /// One event contains the complete, possibly empty, connection snapshot.
    Snapshot {
        entries: Vec<RegisterEntry>,
        revision: Revision,
    },
    Update(RegisterUpdate),
}

#[async_trait]
pub trait RegisterWatch: Send {
    async fn next(&mut self) -> BusResult<WatchEvent>;

    /// True only after this watch delivered its snapshot on this connection.
    fn has_snapshot(&self) -> bool;
}

#[async_trait]
pub trait Register: Send + Sync {
    type Watch: RegisterWatch;

    async fn put(&self, key: &str, value: Vec<u8>) -> BusResult<Revision>;
    async fn get(&self, key: &str) -> BusResult<RegisterValue>;
    async fn delete(&self, key: &str) -> BusResult<Tombstone>;
    async fn watch(&self, prefix: &str) -> BusResult<Self::Watch>;
}