openraft 0.10.0-alpha.18

Advanced Raft consensus
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
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

use std::fmt;

use openraft_macros::since;

use crate::AppData;
use crate::EntryPayload;
use crate::Membership;
use crate::entry::RaftEntry;
use crate::entry::RaftPayload;
use crate::log_id::LogId;
use crate::node::Node;
use crate::node::NodeId;
use crate::vote::RaftCommittedLeaderId;

/// A Raft log entry.
#[since(version = "0.10.0", change = "from `Entry<C>` to `Entry<CLID, D, NID, N>`")]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize), serde(bound = ""))]
pub struct Entry<CLID, D, NID, N>
where
    CLID: RaftCommittedLeaderId,
    D: AppData,
    NID: NodeId,
    N: Node,
{
    /// The log ID uniquely identifying this entry.
    pub log_id: LogId<CLID>,

    /// This entry's payload.
    pub payload: EntryPayload<D, NID, N>,
}

impl<CLID, D, NID, N> Clone for Entry<CLID, D, NID, N>
where
    CLID: RaftCommittedLeaderId,
    D: AppData + Clone,
    NID: NodeId,
    N: Node,
{
    fn clone(&self) -> Self {
        Self {
            log_id: self.log_id.clone(),
            payload: self.payload.clone(),
        }
    }
}

impl<CLID, D, NID, N> fmt::Debug for Entry<CLID, D, NID, N>
where
    CLID: RaftCommittedLeaderId,
    D: AppData,
    NID: NodeId,
    N: Node,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Entry").field("log_id", &self.log_id).field("payload", &self.payload).finish()
    }
}

impl<CLID, D, NID, N> PartialEq for Entry<CLID, D, NID, N>
where
    CLID: RaftCommittedLeaderId,
    D: AppData + PartialEq,
    NID: NodeId,
    N: Node,
{
    fn eq(&self, other: &Self) -> bool {
        self.log_id == other.log_id && self.payload == other.payload
    }
}

impl<CLID, D, NID, N> AsRef<Entry<CLID, D, NID, N>> for Entry<CLID, D, NID, N>
where
    CLID: RaftCommittedLeaderId,
    D: AppData,
    NID: NodeId,
    N: Node,
{
    fn as_ref(&self) -> &Entry<CLID, D, NID, N> {
        self
    }
}

impl<CLID, D, NID, N> fmt::Display for Entry<CLID, D, NID, N>
where
    CLID: RaftCommittedLeaderId,
    D: AppData,
    NID: NodeId,
    N: Node,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}:{}", self.log_id, self.payload)
    }
}

impl<CLID, D, NID, N> RaftPayload<NID, N> for Entry<CLID, D, NID, N>
where
    CLID: RaftCommittedLeaderId,
    D: AppData,
    NID: NodeId,
    N: Node,
{
    fn get_membership(&self) -> Option<Membership<NID, N>> {
        self.payload.get_membership()
    }
}

impl<CLID, D, NID, N> RaftEntry for Entry<CLID, D, NID, N>
where
    CLID: RaftCommittedLeaderId,
    D: AppData,
    NID: NodeId,
    N: Node,
{
    type CommittedLeaderId = CLID;
    type D = D;
    type NodeId = NID;
    type Node = N;

    fn new(log_id: LogId<CLID>, payload: EntryPayload<D, NID, N>) -> Self {
        Self { log_id, payload }
    }

    fn log_id_parts(&self) -> (&CLID, u64) {
        (&self.log_id.leader_id, self.log_id.index)
    }

    fn set_log_id(&mut self, new: LogId<CLID>) {
        self.log_id = new;
    }
}