Struct RaftNode 

pub struct RaftNode { /* private fields */ }

A node in the Raft cluster. Supports pluggable state machine backends for flexible storage integration.

Implementations

impl RaftNode

pub fn new(id: impl Into<NodeId>, config: RaftConfig) -> Self

Create a new Raft node with the default in-memory state machine.

pub fn with_state_machine( id: impl Into<NodeId>, config: RaftConfig, state_machine: Arc<dyn StateMachineBackend>, ) -> Self

Create a new Raft node with a custom state machine backend. Use this to integrate Raft with your storage layer.

pub fn id(&self) -> NodeId

Get the node ID.

pub fn role(&self) -> NodeRole

Get the current role.

pub fn current_term(&self) -> Term

Get the current term.

pub fn leader_id(&self) -> Option<NodeId>

Get the current leader ID.

pub fn is_leader(&self) -> bool

Check if this node is the leader.

pub fn is_leader_with_lease(&self) -> bool

Check if this node is the leader and holds a valid lease. Unlike is_leader(), this also verifies that the leader has recently received acknowledgements from a majority, preventing split-brain.

pub fn extend_lease(&self)

Extend the leader lease to now + lease_duration. Called when the leader receives successful acks from a majority.

pub fn has_valid_lease(&self) -> bool

Check if the leader lease is still valid.

pub fn check_lease(&self)

Periodic check: if this node is leader but the lease has expired, step down to follower to prevent split-brain.

pub fn add_peer(&self, peer_id: NodeId)

Add a peer to the cluster.

pub fn remove_peer(&self, peer_id: &NodeId)

Remove a peer from the cluster.

pub fn peers(&self) -> Vec<NodeId>

Get the list of peers.

pub fn cluster_size(&self) -> usize

Get the cluster size (including self).

pub fn quorum_size(&self) -> usize

Get the quorum size.

pub fn reset_heartbeat(&self)

Reset the heartbeat timer.

pub fn election_timeout_elapsed(&self) -> bool

Check if the election timeout has elapsed.

pub fn start_election(&self) -> VoteRequest

Start an election as a candidate.

pub fn handle_vote_request(&self, request: &VoteRequest) -> VoteResponse

Handle a vote request.

pub fn handle_vote_response(&self, response: &VoteResponse) -> bool

Handle a vote response.

pub fn propose(&self, command: Command) -> Result<LogIndex, String>

Propose a command (leader only).

pub fn create_append_entries( &self, peer_id: &NodeId, ) -> Option<AppendEntriesRequest>

Create an append entries request for a peer.

pub fn handle_append_entries( &self, request: &AppendEntriesRequest, ) -> AppendEntriesResponse

Handle an append entries request.

pub fn handle_append_entries_response( &self, peer_id: &NodeId, response: &AppendEntriesResponse, )

Handle an append entries response.

pub fn apply_committed(&self) -> Vec<CommandResult>

Apply committed entries to the state machine.

pub fn get(&self, key: &str) -> Option<Vec<u8>>

Get a value from the state machine.

pub fn log(&self) -> &ReplicatedLog

Get the log.

pub fn state_machine(&self) -> &dyn StateMachineBackend

Get the state machine.

pub fn should_snapshot(&self) -> bool

Check if a snapshot should be taken based on log size.

pub fn take_snapshot(&self) -> Option<SnapshotMetadata>

Take a snapshot of the current state and compact the log. Returns the snapshot metadata if successful.

pub fn get_snapshot_data(&self) -> Option<(SnapshotMetadata, Vec<u8>)>

Get the current snapshot data (for sending to followers).

pub fn create_install_snapshot( &self, peer_id: &NodeId, offset: u64, ) -> Option<InstallSnapshotRequest>

Create an InstallSnapshot request for a lagging peer. Returns None if no snapshot is available or peer doesn’t need it.

pub fn handle_install_snapshot( &self, request: &InstallSnapshotRequest, ) -> InstallSnapshotResponse

Handle an InstallSnapshot request from the leader.

pub fn handle_install_snapshot_response( &self, peer_id: &NodeId, response: &InstallSnapshotResponse, _last_chunk_offset: u64, was_last_chunk: bool, )

Handle an InstallSnapshot response from a follower.

pub fn peer_needs_snapshot(&self, peer_id: &NodeId) -> bool

Check if a peer needs a snapshot (their next_index is before our first log entry).

pub fn snapshot_metadata(&self) -> Option<SnapshotMetadata>

Get current snapshot metadata.