Change: move log id related traits to mod openraft::log_id

Move trait `RaftLogId`, `LogIdOptionExt` and `LogIndexOptionExt` from `openraft::raft_types` to mod `openraft::log_id`

openraft/src/core/raft_core.rs

@@ -44,6 +44,8 @@ use crate::error::InitializeError;
 use crate::error::QuorumNotEnough;
 use crate::error::RPCError;
 use crate::error::Timeout;
+use crate::log_id::LogIdOptionExt;
+use crate::log_id::RaftLogId;
 use crate::metrics::RaftMetrics;
 use crate::metrics::ReplicationMetrics;
 use crate::metrics::UpdateMatchedLogId;
@@ -63,8 +65,6 @@ use crate::raft::VoteRequest;
 use crate::raft::VoteResponse;
 use crate::raft::VoteTx;
 use crate::raft_state::LogStateReader;
-use crate::raft_types::LogIdOptionExt;
-use crate::raft_types::RaftLogId;
 use crate::replication::Replicate;
 use crate::replication::ReplicationCore;
 use crate::replication::ReplicationHandle;

openraft/src/core/replication_state.rs

@@ -1,4 +1,4 @@
-use crate::raft_types::LogIndexOptionExt;
+use crate::log_id::LogIndexOptionExt;
 
 /// Calculate the distance between the matched log index on a replication target and local last log
 /// index

openraft/src/defensive.rs

@@ -4,7 +4,7 @@ use std::ops::RangeBounds;
 
 use async_trait::async_trait;
 
-use crate::raft_types::LogIdOptionExt;
+use crate::log_id::LogIdOptionExt;
 use crate::DefensiveError;
 use crate::Entry;
 use crate::ErrorSubject;

openraft/src/engine/log_id_list.rs

@@ -1,4 +1,4 @@
-use crate::raft_types::RaftLogId;
+use crate::log_id::RaftLogId;
 use crate::storage::StorageHelper;
 use crate::LogId;
 use crate::LogIdOptionExt;

openraft/src/entry/entry_ref.rs

@@ -2,7 +2,7 @@ use std::fmt::Debug;
 
 use crate::entry::traits::RaftPayload;
 use crate::entry::RaftEntry;
-use crate::raft_types::RaftLogId;
+use crate::log_id::RaftLogId;
 use crate::EntryPayload;
 use crate::LogId;
 use crate::Membership;

openraft/src/entry/mod.rs

@@ -1,6 +1,6 @@
 use std::fmt::Debug;
 
-use crate::raft_types::RaftLogId;
+use crate::log_id::RaftLogId;
 use crate::LogId;
 use crate::Membership;
 use crate::MessageSummary;

openraft/src/entry/traits.rs

@@ -1,4 +1,4 @@
-use crate::raft_types::RaftLogId;
+use crate::log_id::RaftLogId;
 use crate::Membership;
 use crate::Node;
 use crate::NodeId;

openraft/src/leader/leader.rs

@@ -1,10 +1,10 @@
 use std::collections::BTreeSet;
 
+use crate::log_id::LogIndexOptionExt;
 use crate::progress::entry::ProgressEntry;
 use crate::progress::Progress;
 use crate::progress::VecProgress;
 use crate::quorum::QuorumSet;
-use crate::raft_types::LogIndexOptionExt;
 use crate::LogId;
 use crate::NodeId;
 use crate::Vote;

openraft/src/lib.rs

@@ -89,6 +89,8 @@ pub use crate::defensive::DefensiveCheck;
 pub use crate::defensive::DefensiveCheckBase;
 pub use crate::entry::Entry;
 pub use crate::entry::EntryPayload;
+pub use crate::log_id::LogIdOptionExt;
+pub use crate::log_id::LogIndexOptionExt;
 pub use crate::membership::EffectiveMembership;
 pub use crate::membership::Membership;
 pub use crate::membership::StoredMembership;
@@ -104,7 +106,6 @@ pub use crate::raft::Raft;
 pub use crate::raft::RaftTypeConfig;
 pub use crate::raft_state::MembershipState;
 pub use crate::raft_state::RaftState;
-pub use crate::raft_types::LogIdOptionExt;
 pub(crate) use crate::raft_types::MetricsChangeFlags;
 pub use crate::raft_types::SnapshotId;
 pub use crate::raft_types::SnapshotSegmentId;

openraft/src/log_id/log_id_option_ext.rs

@@ -0,0 +1,33 @@
+use crate::LogId;
+use crate::NodeId;
+
+pub trait LogIdOptionExt {
+    fn index(&self) -> Option<u64>;
+    fn next_index(&self) -> u64;
+}
+
+impl<NID: NodeId> LogIdOptionExt for Option<LogId<NID>> {
+    fn index(&self) -> Option<u64> {
+        self.map(|x| x.index)
+    }
+
+    fn next_index(&self) -> u64 {
+        match self {
+            None => 0,
+            Some(log_id) => log_id.index + 1,
+        }
+    }
+}
+
+impl<NID: NodeId> LogIdOptionExt for Option<&LogId<NID>> {
+    fn index(&self) -> Option<u64> {
+        self.map(|x| x.index)
+    }
+
+    fn next_index(&self) -> u64 {
+        match self {
+            None => 0,
+            Some(log_id) => log_id.index + 1,
+        }
+    }
+}

openraft/src/log_id/log_index_option_ext.rs

@@ -0,0 +1,33 @@
+pub trait LogIndexOptionExt {
+    fn next_index(&self) -> u64;
+    fn prev_index(&self) -> Self;
+    fn add(&self, v: u64) -> Self;
+}
+
+impl LogIndexOptionExt for Option<u64> {
+    fn next_index(&self) -> u64 {
+        match self {
+            None => 0,
+            Some(v) => v + 1,
+        }
+    }
+
+    fn prev_index(&self) -> Self {
+        match self {
+            None => {
+                panic!("None has no previous value");
+            }
+            Some(v) => {
+                if *v == 0 {
+                    None
+                } else {
+                    Some(*v - 1)
+                }
+            }
+        }
+    }
+
+    fn add(&self, v: u64) -> Self {
+        Some(self.next_index() + v).prev_index()
+    }
+}

openraft/src/log_id/mod.rs

@@ -1,13 +1,18 @@
+mod log_id_option_ext;
+mod log_index_option_ext;
+mod raft_log_id;
+
 use std::fmt::Display;
 use std::fmt::Formatter;
 
-use crate::raft_types::RaftLogId;
+pub use log_id_option_ext::LogIdOptionExt;
+pub use log_index_option_ext::LogIndexOptionExt;
+pub use raft_log_id::RaftLogId;
+
 use crate::CommittedLeaderId;
 use crate::MessageSummary;
 use crate::NodeId;
 
-mod traits;
-
 /// The identity of a raft log.
 /// A term, node_id and an index identifies an log globally.
 #[derive(Debug, Default, Copy, Clone, PartialOrd, Ord, PartialEq, Eq)]

openraft/src/log_id/raft_log_id.rs

@@ -0,0 +1,22 @@
+use crate::CommittedLeaderId;
+use crate::LogId;
+use crate::NodeId;
+
+/// Defines API to operate an object that contains a log-id, such as a log entry or a log id.
+pub trait RaftLogId<NID: NodeId> {
+    /// Returns a reference to the leader id that proposed this log id.  
+    ///
+    /// When a `LeaderId` is committed, some of its data can be discarded.
+    /// For example, a leader id in standard raft is `(term, node_id)`, but a log id does not have
+    /// to store the `node_id`, because in standard raft there is at most one leader that can be
+    /// established.
+    fn leader_id(&self) -> &CommittedLeaderId<NID> {
+        self.get_log_id().committed_leader_id()
+    }
+
+    /// Return a reference to the log-id it stores.
+    fn get_log_id(&self) -> &LogId<NID>;
+
+    /// Update the log id it contains.
+    fn set_log_id(&mut self, log_id: &LogId<NID>);
+}

openraft/src/membership/effective_membership.rs

@@ -3,10 +3,10 @@ use std::fmt::Debug;
 use std::sync::Arc;
 
 use crate::entry::RaftEntry;
+use crate::log_id::RaftLogId;
 use crate::node::Node;
 use crate::quorum::Joint;
 use crate::quorum::QuorumSet;
-use crate::raft_types::RaftLogId;
 use crate::LogId;
 use crate::Membership;
 use crate::MessageSummary;

openraft/src/metrics/wait_test.rs

@@ -7,9 +7,9 @@ use tokio::sync::watch;
 use tokio::time::sleep;
 
 use crate::core::ServerState;
+use crate::log_id::LogIdOptionExt;
 use crate::metrics::Wait;
 use crate::metrics::WaitError;
-use crate::raft_types::LogIdOptionExt;
 use crate::vote::CommittedLeaderId;
 use crate::LogId;
 use crate::Membership;

openraft/src/raft_state/mod.rs

@@ -8,8 +8,8 @@ use crate::entry::RaftEntry;
 use crate::equal;
 use crate::error::ForwardToLeader;
 use crate::less_equal;
+use crate::log_id::RaftLogId;
 use crate::node::Node;
-use crate::raft_types::RaftLogId;
 use crate::utime::UTime;
 use crate::validate::Validate;
 use crate::LogId;

openraft/src/raft_types.rs

@@ -1,85 +1,6 @@
 use std::fmt::Display;
 use std::fmt::Formatter;
 
-use crate::vote::CommittedLeaderId;
-use crate::LogId;
-use crate::NodeId;
-
-pub trait RaftLogId<NID: NodeId> {
-    fn leader_id(&self) -> &CommittedLeaderId<NID> {
-        self.get_log_id().committed_leader_id()
-    }
-
-    fn get_log_id(&self) -> &LogId<NID>;
-
-    fn set_log_id(&mut self, log_id: &LogId<NID>);
-}
-
-pub trait LogIdOptionExt {
-    fn index(&self) -> Option<u64>;
-    fn next_index(&self) -> u64;
-}
-
-impl<NID: NodeId> LogIdOptionExt for Option<LogId<NID>> {
-    fn index(&self) -> Option<u64> {
-        self.map(|x| x.index)
-    }
-
-    fn next_index(&self) -> u64 {
-        match self {
-            None => 0,
-            Some(log_id) => log_id.index + 1,
-        }
-    }
-}
-
-impl<NID: NodeId> LogIdOptionExt for Option<&LogId<NID>> {
-    fn index(&self) -> Option<u64> {
-        self.map(|x| x.index)
-    }
-
-    fn next_index(&self) -> u64 {
-        match self {
-            None => 0,
-            Some(log_id) => log_id.index + 1,
-        }
-    }
-}
-
-pub trait LogIndexOptionExt {
-    fn next_index(&self) -> u64;
-    fn prev_index(&self) -> Self;
-    fn add(&self, v: u64) -> Self;
-}
-
-impl LogIndexOptionExt for Option<u64> {
-    fn next_index(&self) -> u64 {
-        match self {
-            None => 0,
-            Some(v) => v + 1,
-        }
-    }
-
-    fn prev_index(&self) -> Self {
-        match self {
-            None => {
-                panic!("None has no previous value");
-            }
-            Some(v) => {
-                if *v == 0 {
-                    None
-                } else {
-                    Some(*v - 1)
-                }
-            }
-        }
-    }
-
-    fn add(&self, v: u64) -> Self {
-        Some(self.next_index() + v).prev_index()
-    }
-}
-
 // Everytime a snapshot is created, it is assigned with a globally unique id.
 pub type SnapshotId = String;
 

openraft/src/replication/mod.rs

@@ -25,12 +25,12 @@ use crate::error::HigherVote;
 use crate::error::RPCError;
 use crate::error::ReplicationError;
 use crate::error::Timeout;
+use crate::log_id::LogIdOptionExt;
 use crate::log_id_range::LogIdRange;
 use crate::raft::AppendEntriesRequest;
 use crate::raft::AppendEntriesResponse;
 use crate::raft::InstallSnapshotRequest;
 use crate::raft::RaftMsg;
-use crate::raft_types::LogIdOptionExt;
 use crate::storage::RaftLogReader;
 use crate::storage::Snapshot;
 use crate::ErrorSubject;

openraft/src/runtime/mod.rs

@@ -1,5 +1,5 @@
 use crate::engine::Command;
-use crate::raft_types::RaftLogId;
+use crate::log_id::RaftLogId;
 use crate::Entry;
 use crate::RaftTypeConfig;
 use crate::StorageError;