Struct MsgBuilder

pub struct MsgBuilder { /* private fields */ }

A helper struct contains all infos about how to create a message.

User should read the term of previous log (id is from_id()-1), the logs between range [from_id(), until_id()], and provides those infos to MsgBuilder to build pending messages. After that, user is to send this message to remote_id().

WARNING: User should check the value of channel_id() to determine whether invoke whick build function. If the value of is INDEX_CHANNEL_ID, invokes build_index_msg(), otherwise invokes build_append_msg().

Implementations

impl MsgBuilder

pub fn local_id(&self) -> u64

The node this pending message send from.

pub fn remote_id(&self) -> u64

The node this pending message send to.

pub fn channel_id(&self) -> u64

The channel this message belongs to.

pub fn from_id(&self) -> u64

The first log id need to read.

pub fn until_id(&self) -> u64

The last log id need to read.

pub fn build_append_msg( builder: &Self, prev_term: u64, entries: Vec<Entry>, ) -> Message

pub fn build_index_msg( builder: &Self, prev_term: u64, indexes: Vec<LogIndex>, ) -> Message

Trait Implementations

impl Debug for MsgBuilder

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

Formats the value using the given formatter.