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

//! Dynamic multi-Raft catalog replication over group 0 (Tier 2).

use serde::{Deserialize, Serialize};

use crate::NodeId;

/// Catalog metadata replicated through group 0's Raft log (not the user SM).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum CatalogCommand {
    /// Append contiguous group ids after `from_len`.
    AddGroups {
        /// Catalog length before this entry (idempotency check).
        from_len: u32,
        /// Contiguous new group ids appended in order.
        new_groups: Vec<u32>,
    },
}

/// Request to grow the multi-Raft group catalog (`/cluster/catalog/add`).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct CatalogAddRequest {
    /// Wire/protocol version of the caller.
    pub protocol_version: u32,
    /// Number of contiguous Raft groups to append.
    pub add_groups: u32,
}

/// Response to a [`CatalogAddRequest`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum CatalogAddResponse {
    /// Catalog change committed by the group 0 leader.
    Accepted {
        /// Current group 0 leader.
        leader: NodeId,
        /// Catalog length after expansion.
        catalog_len: u32,
        /// New group ids appended by this request.
        new_groups: Vec<u32>,
    },
    /// Contacted node is not the group 0 leader; retry against `leader`.
    Redirect {
        /// Best-known current leader, if any.
        leader: Option<NodeId>,
    },
    /// Request refused.
    Rejected {
        /// Why the request was refused.
        reason: CatalogRejection,
    },
}

/// Reason a [`CatalogAddRequest`] was rejected.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum CatalogRejection {
    /// Protocol version mismatch.
    VersionSkew {
        /// Version the cluster expects.
        expected: u32,
        /// Version the caller offered.
        got: u32,
    },
    /// Single-group clusters cannot expand the catalog.
    NotMultiRaft,
    /// Planner rejected the expansion (invalid count or catalog state).
    InvalidExpansion(String),
    /// Any other refusal, human-readable.
    Other(String),
}