Struct raft::raw_node::Ready

pub struct Ready { /* private fields */ }

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

Implementations

impl Ready

pub fn number(&self) -> u64

The number of current Ready. It is used for identifying the different Ready and ReadyRecord.

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

The current volatile state of a Node. SoftState will be None 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. HardState will be None state if there is no update.

pub fn read_states(&self) -> &Vec<ReadState>

ReadStates specifies the state for read only query.

pub fn take_read_states(&mut self) -> Vec<ReadState>

Take the ReadStates.

pub fn entries(&self) -> &Vec<Entry>

Entries specifies entries to be saved to stable storage.

pub fn take_entries(&mut self) -> Vec<Entry>

Take the Entries.

pub fn snapshot(&self) -> &Snapshot

Snapshot specifies the snapshot to be saved to stable storage.

pub fn committed_entries(&self) -> &Vec<Entry>

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

pub fn take_committed_entries(&mut self) -> Vec<Entry>

Take the CommitEntries.

pub fn messages(&self) -> &[Message]

Messages specifies outbound messages to be sent. 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.

pub fn take_messages(&mut self) -> Vec<Message>

Take the Messages.

pub fn persisted_messages(&self) -> &[Message]

Persisted Messages specifies outbound messages to be sent AFTER the HardState, Entries and Snapshot are persisted to stable storage.

pub fn take_persisted_messages(&mut self) -> Vec<Message>

Take the Persisted Messages.

pub fn must_sync(&self) -> bool

MustSync is false if and only if

1. no HardState or only its commit is different from before
2. no Entries and Snapshot If it’s false, an asynchronous write of HardState is permissible before calling RawNode::on_persist_ready or RawNode::advance or its families.

Trait Implementations

impl Debug for Ready

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

Formats the value using the given formatter.

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: &Rhs) -> bool

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

impl StructuralPartialEq for Ready