Skip to content

Commit c55c962

Browse files
committed
Refactor: rename RaftLeaderId::node_id_ref() to node_id()
Follow the Rust naming guide: https://rust-lang.github.io/api-guidelines/naming.html#getter-names-follow-rust-convention-c-getter
1 parent 959a663 commit c55c962

File tree

12 files changed

+17
-17
lines changed

12 files changed

+17
-17
lines changed

examples/raft-kv-memstore-grpc/src/pb_impl/impl_leader_id.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ impl RaftLeaderId<TypeConfig> for pb::LeaderId {
4141
self.term
4242
}
4343

44-
fn node_id_ref(&self) -> Option<&u64> {
44+
fn node_id(&self) -> Option<&u64> {
4545
Some(&self.node_id)
4646
}
4747

openraft/src/core/raft_core.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -727,7 +727,7 @@ where
727727
}
728728

729729
// Safe unwrap(): vote that is committed has to already have voted for some node.
730-
let id = vote.leader_id().node_id_ref().cloned().unwrap();
730+
let id = vote.leader_id().node_id().cloned().unwrap();
731731

732732
// TODO: `is_voter()` is slow, maybe cache `current_leader`,
733733
// e.g., only update it when membership or vote changes

openraft/src/engine/handler/establish_handler/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ where C: RaftTypeConfig
2525
let vote = candidate.vote_ref().clone();
2626

2727
debug_assert_eq!(
28-
vote.leader_id().node_id_ref(),
28+
vote.leader_id().node_id(),
2929
Some(&self.config.id),
3030
"it can only commit its own vote"
3131
);

openraft/src/engine/handler/vote_handler/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ where C: RaftTypeConfig
221221
/// This node then becomes raft-follower or raft-learner.
222222
pub(crate) fn become_following(&mut self) {
223223
debug_assert!(
224-
self.state.vote_ref().leader_id().node_id_ref() != Some(&self.config.id)
224+
self.state.vote_ref().leader_id().node_id() != Some(&self.config.id)
225225
|| !self.state.membership_state.effective().membership().is_voter(&self.config.id),
226226
"It must hold: vote is not mine, or I am not a voter(leader just left the cluster)"
227227
);

openraft/src/proposer/leader.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ where
203203
// Thus vote.voted_for() is this node.
204204

205205
// Safe unwrap: voted_for() is always non-None in Openraft
206-
let node_id = self.committed_vote.clone().into_vote().leader_id().node_id_ref().cloned().unwrap();
206+
let node_id = self.committed_vote.clone().into_vote().leader_id().node_id().cloned().unwrap();
207207
let now = C::now();
208208

209209
tracing::debug!(

openraft/src/raft_state/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ where C: RaftTypeConfig
368368
///
369369
/// [Determine Server State]: crate::docs::data::vote#vote-and-membership-define-the-server-state
370370
pub(crate) fn is_leading(&self, id: &C::NodeId) -> bool {
371-
self.membership_state.contains(id) && self.vote.leader_id().node_id_ref() == Some(id)
371+
self.membership_state.contains(id) && self.vote.leader_id().node_id() == Some(id)
372372
}
373373

374374
/// The node is leader
@@ -408,7 +408,7 @@ where C: RaftTypeConfig
408408

409409
if vote.is_committed() {
410410
// Safe unwrap(): vote that is committed has to already have voted for some node.
411-
let id = vote.leader_id().node_id_ref().cloned().unwrap();
411+
let id = vote.leader_id().node_id().cloned().unwrap();
412412

413413
return self.new_forward_to_leader(id);
414414
}

openraft/src/replication/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ where
443443
let append_res = res.map_err(|_e| {
444444
let to = Timeout {
445445
action: RPCTypes::AppendEntries,
446-
id: self.session_id.vote().leader_id().node_id_ref().cloned().unwrap(),
446+
id: self.session_id.vote().leader_id().node_id().cloned().unwrap(),
447447
target: self.target.clone(),
448448
timeout: the_timeout,
449449
};

openraft/src/vote/leader_id/leader_id_adv.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ where C: RaftTypeConfig<LeaderId = Self>
5555
self.term
5656
}
5757

58-
fn node_id_ref(&self) -> Option<&C::NodeId> {
58+
fn node_id(&self) -> Option<&C::NodeId> {
5959
Some(&self.node_id)
6060
}
6161

openraft/src/vote/leader_id/leader_id_cmp.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ where C: RaftTypeConfig
1919
pub fn std<LID>(a: &LID, b: &LID) -> Option<Ordering>
2020
where LID: RaftLeaderId<C> {
2121
match a.term().cmp(&b.term()) {
22-
Ordering::Equal => match (a.node_id_ref(), b.node_id_ref()) {
22+
Ordering::Equal => match (a.node_id(), b.node_id()) {
2323
(None, None) => Some(Ordering::Equal),
2424
(Some(_), None) => Some(Ordering::Greater),
2525
(None, Some(_)) => Some(Ordering::Less),
@@ -38,7 +38,7 @@ where C: RaftTypeConfig
3838
/// Implements [`PartialOrd`] for LeaderId to allow multiple leaders per term.
3939
pub fn adv<LID>(a: &LID, b: &LID) -> Option<Ordering>
4040
where LID: RaftLeaderId<C> {
41-
let res = (a.term(), a.node_id_ref()).cmp(&(b.term(), b.node_id_ref()));
41+
let res = (a.term(), a.node_id()).cmp(&(b.term(), b.node_id()));
4242
Some(res)
4343
}
4444
}
@@ -66,7 +66,7 @@ mod tests {
6666
self.0
6767
}
6868

69-
fn node_id_ref(&self) -> Option<&u64> {
69+
fn node_id(&self) -> Option<&u64> {
7070
self.1.as_ref()
7171
}
7272

openraft/src/vote/leader_id/leader_id_std.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ where C: RaftTypeConfig
5959
self.term
6060
}
6161

62-
fn node_id_ref(&self) -> Option<&C::NodeId> {
62+
fn node_id(&self) -> Option<&C::NodeId> {
6363
self.voted_for.as_ref()
6464
}
6565

openraft/src/vote/leader_id/raft_leader_id.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ where
3838
fn term(&self) -> C::Term;
3939

4040
/// Get the node ID of this leader, if one is set
41-
fn node_id_ref(&self) -> Option<&C::NodeId>;
41+
fn node_id(&self) -> Option<&C::NodeId>;
4242

4343
/// Convert this leader ID to a committed leader ID.
4444
///
@@ -59,7 +59,7 @@ where
5959
}
6060

6161
fn node_id(&self) -> Option<C::NodeId> {
62-
self.node_id_ref().cloned()
62+
self.node_id().cloned()
6363
}
6464
}
6565

tests/tests/fixtures/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -892,7 +892,7 @@ impl TypedRaftRouter {
892892

893893
if let Some(voted_for) = &expect_voted_for {
894894
assert_eq!(
895-
vote.leader_id().node_id_ref(),
895+
vote.leader_id().node_id(),
896896
Some(voted_for),
897897
"expected node {} to have voted for {}, got {:?}",
898898
id,
@@ -1022,7 +1022,7 @@ impl RaftNetworkV2<MemConfig> for RaftRouterNetwork {
10221022
mut rpc: AppendEntriesRequest<MemConfig>,
10231023
_option: RPCOption,
10241024
) -> Result<AppendEntriesResponse<MemConfig>, RPCError<MemConfig>> {
1025-
let from_id = rpc.vote.leader_id().node_id_ref().cloned().unwrap();
1025+
let from_id = rpc.vote.leader_id().node_id().cloned().unwrap();
10261026

10271027
tracing::debug!("append_entries to id={} {}", self.target, rpc);
10281028
self.owner.count_rpc(RPCTypes::AppendEntries);

0 commit comments

Comments
 (0)