|
| 1 | +use std::fmt::Debug; |
| 2 | + |
| 3 | +use crate::LogId; |
| 4 | +use crate::Membership; |
| 5 | +use crate::MessageSummary; |
| 6 | +use crate::NodeId; |
| 7 | +use crate::RaftTypeConfig; |
| 8 | + |
| 9 | +/// Defines operations on an entry payload. |
| 10 | +pub trait RaftPayload<NID: NodeId> { |
| 11 | + /// Return `Some(())` if the entry payload is blank. |
| 12 | + fn is_blank(&self) -> bool; |
| 13 | + |
| 14 | + /// Return `Some(&Membership)` if the entry payload is a membership payload. |
| 15 | + fn get_membership(&self) -> Option<&Membership<NID>>; |
| 16 | +} |
| 17 | + |
| 18 | +/// Defines operations on an entry. |
| 19 | +pub trait RaftEntry<NID: NodeId>: RaftPayload<NID> { |
| 20 | + fn get_log_id(&self) -> &LogId<NID>; |
| 21 | + |
| 22 | + fn set_log_id(&mut self, log_id: &LogId<NID>); |
| 23 | +} |
| 24 | + |
| 25 | +/// Log entry payload variants. |
| 26 | +#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)] |
| 27 | +pub enum EntryPayload<C: RaftTypeConfig> { |
| 28 | + /// An empty payload committed by a new cluster leader. |
| 29 | + Blank, |
| 30 | + |
| 31 | + Normal(C::D), |
| 32 | + |
| 33 | + /// A change-membership log entry. |
| 34 | + Membership(Membership<C::NodeId>), |
| 35 | +} |
| 36 | + |
| 37 | +impl<C: RaftTypeConfig> MessageSummary for EntryPayload<C> { |
| 38 | + fn summary(&self) -> String { |
| 39 | + match self { |
| 40 | + EntryPayload::Blank => "blank".to_string(), |
| 41 | + EntryPayload::Normal(_n) => "normal".to_string(), |
| 42 | + EntryPayload::Membership(c) => { |
| 43 | + format!("membership: {}", c.summary()) |
| 44 | + } |
| 45 | + } |
| 46 | + } |
| 47 | +} |
| 48 | + |
| 49 | +/// A Raft log entry. |
| 50 | +#[derive(Clone, serde::Serialize, serde::Deserialize)] |
| 51 | +pub struct Entry<C: RaftTypeConfig> { |
| 52 | + pub log_id: LogId<C::NodeId>, |
| 53 | + |
| 54 | + /// This entry's payload. |
| 55 | + #[serde(bound = "")] |
| 56 | + pub payload: EntryPayload<C>, |
| 57 | +} |
| 58 | + |
| 59 | +impl<C: RaftTypeConfig> Debug for Entry<C> |
| 60 | +where C::D: Debug |
| 61 | +{ |
| 62 | + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { |
| 63 | + f.debug_struct("Entry").field("log_id", &self.log_id).field("payload", &self.payload).finish() |
| 64 | + } |
| 65 | +} |
| 66 | + |
| 67 | +impl<C: RaftTypeConfig> Default for Entry<C> { |
| 68 | + fn default() -> Self { |
| 69 | + Self { |
| 70 | + log_id: LogId::default(), |
| 71 | + payload: EntryPayload::Blank, |
| 72 | + } |
| 73 | + } |
| 74 | +} |
| 75 | + |
| 76 | +impl<C: RaftTypeConfig> MessageSummary for Entry<C> { |
| 77 | + fn summary(&self) -> String { |
| 78 | + format!("{}:{}", self.log_id, self.payload.summary()) |
| 79 | + } |
| 80 | +} |
| 81 | + |
| 82 | +impl<C: RaftTypeConfig> MessageSummary for Option<Entry<C>> { |
| 83 | + fn summary(&self) -> String { |
| 84 | + match self { |
| 85 | + None => "None".to_string(), |
| 86 | + Some(x) => format!("Some({})", x.summary()), |
| 87 | + } |
| 88 | + } |
| 89 | +} |
| 90 | + |
| 91 | +impl<C: RaftTypeConfig> MessageSummary for &[Entry<C>] { |
| 92 | + fn summary(&self) -> String { |
| 93 | + let entry_refs: Vec<_> = self.iter().collect(); |
| 94 | + entry_refs.as_slice().summary() |
| 95 | + } |
| 96 | +} |
| 97 | + |
| 98 | +impl<C: RaftTypeConfig> MessageSummary for &[&Entry<C>] { |
| 99 | + fn summary(&self) -> String { |
| 100 | + if self.is_empty() { |
| 101 | + return "{}".to_string(); |
| 102 | + } |
| 103 | + let mut res = Vec::with_capacity(self.len()); |
| 104 | + if self.len() <= 5 { |
| 105 | + for x in self.iter() { |
| 106 | + let e = format!("{}:{}", x.log_id, x.payload.summary()); |
| 107 | + res.push(e); |
| 108 | + } |
| 109 | + |
| 110 | + res.join(",") |
| 111 | + } else { |
| 112 | + let first = *self.first().unwrap(); |
| 113 | + let last = *self.last().unwrap(); |
| 114 | + |
| 115 | + format!("{} ... {}", first.summary(), last.summary()) |
| 116 | + } |
| 117 | + } |
| 118 | +} |
| 119 | + |
| 120 | +impl<C: RaftTypeConfig> RaftPayload<C::NodeId> for EntryPayload<C> { |
| 121 | + fn is_blank(&self) -> bool { |
| 122 | + matches!(self, EntryPayload::Blank) |
| 123 | + } |
| 124 | + |
| 125 | + fn get_membership(&self) -> Option<&Membership<C::NodeId>> { |
| 126 | + if let EntryPayload::Membership(m) = self { |
| 127 | + Some(m) |
| 128 | + } else { |
| 129 | + None |
| 130 | + } |
| 131 | + } |
| 132 | +} |
| 133 | + |
| 134 | +impl<C: RaftTypeConfig> RaftPayload<C::NodeId> for Entry<C> { |
| 135 | + fn is_blank(&self) -> bool { |
| 136 | + self.payload.is_blank() |
| 137 | + } |
| 138 | + |
| 139 | + fn get_membership(&self) -> Option<&Membership<C::NodeId>> { |
| 140 | + self.payload.get_membership() |
| 141 | + } |
| 142 | +} |
| 143 | + |
| 144 | +impl<C: RaftTypeConfig> RaftEntry<C::NodeId> for Entry<C> { |
| 145 | + fn get_log_id(&self) -> &LogId<C::NodeId> { |
| 146 | + &self.log_id |
| 147 | + } |
| 148 | + |
| 149 | + fn set_log_id(&mut self, log_id: &LogId<C::NodeId>) { |
| 150 | + self.log_id = *log_id; |
| 151 | + } |
| 152 | +} |
0 commit comments