crafty-proto 0.2.2

Wire types and postcard codec shared across the crafty framework.
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
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

//! Actor workflow store wire types ([actor-state-store](../../../docs/decisions/actor-state-store.md)).

use serde::{Deserialize, Serialize};

/// Set a workflow key on the leader (`POST /raft/v1/actor-store/set`).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct StoreSetRequest {
    /// UTF-8 key.
    pub key: String,
    /// Opaque value bytes.
    pub value: Vec<u8>,
    /// TTL in seconds (`0` = no expiry).
    #[serde(default)]
    pub ttl_secs: u64,
}

/// Response to [`StoreSetRequest`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct StoreSetReply {
    /// Set when the mutation failed.
    pub error: Option<String>,
}

/// Delete a workflow key on the leader (`POST /raft/v1/actor-store/delete`).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct StoreDeleteRequest {
    /// Key to remove.
    pub key: String,
}

/// Response to [`StoreDeleteRequest`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct StoreDeleteReply {
    /// Set when the mutation failed.
    pub error: Option<String>,
}

/// Compare-and-set on the leader (`POST /raft/v1/actor-store/compare-and-set`).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct StoreCompareAndSetRequest {
    /// Key to update.
    pub key: String,
    /// Expected current value (`None` = key must be absent).
    pub expected: Option<Vec<u8>>,
    /// New value when the precondition holds.
    pub value: Vec<u8>,
    /// TTL in seconds for the new value (`0` = no expiry).
    #[serde(default)]
    pub ttl_secs: u64,
}

/// Response to [`StoreCompareAndSetRequest`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct StoreCompareAndSetReply {
    /// Whether the swap happened.
    pub applied: bool,
    /// Set when the RPC failed (not when the precondition did not hold).
    pub error: Option<String>,
}

/// Idempotent mutation replicated from the store leader to every voter.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum StoreReplicateOp {
    /// Upsert a key.
    Set {
        /// Key.
        key: String,
        /// Value bytes.
        value: Vec<u8>,
        /// Expiry unix ms (`0` = never).
        #[serde(default)]
        expires_at_ms: u64,
    },
    /// Remove a key (no-op when absent).
    Delete {
        /// Key.
        key: String,
    },
}

/// Batch of store replication ops from the leader (`POST /raft/v1/actor-store/replicate`).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct StoreReplicateRequest {
    /// Idempotent mutations to apply in order.
    pub ops: Vec<StoreReplicateOp>,
}

/// Response to [`StoreReplicateRequest`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct StoreReplicateReply {
    /// Set when replication apply failed.
    pub error: Option<String>,
}