Struct openraft::RaftState

pub struct RaftState<NID, N, I>
where
    NID: NodeId,
    N: Node,
    I: Instant,
{
    pub committed: Option<LogId<NID>>,
    pub log_ids: LogIdList<NID>,
    pub membership_state: MembershipState<NID, N>,
    pub snapshot_meta: SnapshotMeta<NID, N>,
    pub server_state: ServerState,
    /* private fields */
}

A struct used to represent the raft state which a Raft node needs.

Fields

committed: Option<LogId<NID>>

The LogId of the last log committed(AKA applied) to the state machine.

• Committed means: a log that is replicated to a quorum of the cluster and it is of the term of the leader.

• A quorum could be a uniform quorum or joint quorum.

log_ids: LogIdList<NID>

All log ids this node has.

membership_state: MembershipState<NID, N>

The latest cluster membership configuration found, in log or in state machine.

snapshot_meta: SnapshotMeta<NID, N>

The metadata of the last snapshot.

server_state: ServerState

The state of a Raft node, such as Leader or Follower.

Implementations

impl<NID, N, I> RaftState<NID, N, I>

where NID: NodeId, N: Node, I: Instant,

pub fn vote_ref(&self) -> &Vote<NID>

Get a reference to the current vote.

pub fn vote_last_modified(&self) -> Option<I>

Return the last updated time of the vote.

Trait Implementations

impl<NID, N, I> Clone for RaftState<NID, N, I>

where NID: NodeId + Clone, N: Node + Clone, I: Instant + Clone,

fn clone(&self) -> RaftState<NID, N, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<NID, N, I> Debug for RaftState<NID, N, I>

where NID: NodeId + Debug, N: Node + Debug, I: Instant + Debug,

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

Formats the value using the given formatter.

impl<NID, N, I> Default for RaftState<NID, N, I>

where NID: NodeId, N: Node, I: Instant,

fn default() -> Self

Returns the “default value” for a type.

impl<NID, N, I> PartialEq for RaftState<NID, N, I>

where NID: NodeId + PartialEq, N: Node + PartialEq, I: Instant + PartialEq,

fn eq(&self, other: &RaftState<NID, N, I>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<NID, N, I> Validate for RaftState<NID, N, I>

where NID: NodeId, N: Node, I: Instant,

fn validate(&self) -> Result<(), Box<dyn Error>>

Validate the internal state.

impl<NID, N, I> Eq for RaftState<NID, N, I>

where NID: NodeId + Eq, N: Node + Eq, I: Instant + Eq,

impl<NID, N, I> StructuralPartialEq for RaftState<NID, N, I>

where NID: NodeId, N: Node, I: Instant,