Struct raft::storage::RaftState

pub struct RaftState {
    pub hard_state: HardState,
    pub conf_state: ConfState,
    // some fields omitted
}

Holds both the hard state (commit index, vote leader, term) and the configuration state (Current node IDs)

Fields

hard_state: HardState

Contains the last meta information including commit index, the vote leader, and the vote term.

conf_state: ConfState

Records the current node IDs like [1, 2, 3] in the cluster. Every Raft node must have a unique ID in the cluster;

Methods

impl RaftState

pub fn pending_conf_state(&self) -> &Option<ConfState>

If this peer is in the middle of a membership change (The period between BeginMembershipChange and FinalizeMembershipChange) this will hold the final desired state.

pub fn pending_conf_state_start_index(&self) -> &Option<u64>

If pending_conf_state exists this will contain the index of the BeginMembershipChange entry.

impl RaftState

pub fn new(hard_state: HardState, conf_state: ConfState) -> RaftState

Create a new RaftState.

pub fn initialized(&self) -> bool

Indicates the RaftState is initialized or not.

Trait Implementations

impl Default for RaftState

fn default() -> RaftState

Returns the "default value" for a type.

impl Clone for RaftState

fn clone(&self) -> RaftState

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RaftState

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.