Struct raft::raw_node::Ready

pub struct Ready {
    pub committed_entries: Option<Vec<Entry>>,
    pub messages: Vec<Message>,
    // some fields omitted
}

Ready encapsulates the entries and messages that are ready to read, be saved to stable storage, committed or sent to other peers. All fields in Ready are read-only.

Fields

committed_entries: Option<Vec<Entry>>

CommittedEntries specifies entries to be committed to a store/state-machine. These have previously been committed to stable store.

messages: Vec<Message>

Messages specifies outbound messages to be sent AFTER Entries are committed to stable storage. If it contains a MsgSnap message, the application MUST report back to raft when the snapshot has been received or has failed by calling ReportSnapshot.

Methods

impl Ready

pub fn ss(&self) -> Option<&SoftState>

The current volatile state of a Node. SoftState will be nil if there is no update. It is not required to consume or store SoftState.

pub fn hs(&self) -> Option<&HardState>

The current state of a Node to be saved to stable storage BEFORE Messages are sent. HardState will be equal to empty state if there is no update.

pub fn read_states(&self) -> &[ReadState]

States can be used for node to serve linearizable read requests locally when its applied index is greater than the index in ReadState. Note that the read_state will be returned when raft receives MsgReadIndex. The returned is only valid for the request that requested to read.

pub fn entries(&self) -> &[Entry]

Entries specifies entries to be saved to stable storage BEFORE Messages are sent.

pub fn snapshot(&self) -> &Snapshot

Snapshot specifies the snapshot to be saved to stable storage.

pub fn must_sync(&self) -> bool

MustSync indicates whether the HardState and Entries must be synchronously written to disk or if an asynchronous write is permissible.

Trait Implementations

impl Default for Ready

fn default() -> Ready

Returns the "default value" for a type.

impl PartialEq<Ready> for Ready

fn eq(&self, other: &Ready) -> bool

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

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

This method tests for !=.

impl Debug for Ready

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

Formats the value using the given formatter.