Struct openraft::LeaderId

pub struct LeaderId<NID>
where
    NID: NodeId,
{
    pub term: u64,
    pub node_id: NID,
}

LeaderId is identifier of a leader.

In raft spec that in a term there is at most one leader, thus a term is enough to differentiate leaders. That is why raft uses (term, index) to uniquely identify a log entry.

Under this dirty simplification, a Leader is actually identified by (term, voted_for:Option<node_id>). By introducing LeaderId {term, node_id}, things become easier to understand.

Fields

term: u64

node_id: NID

Implementations

impl<NID: NodeId> LeaderId<NID>

pub fn new(term: u64, node_id: NID) -> Self

pub fn get_term(&self) -> u64

pub fn voted_for(&self) -> Option<NID>

Trait Implementations

impl<NID> Clone for LeaderId<NID>

where NID: NodeId + Clone,

fn clone(&self) -> LeaderId<NID>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<NID> Debug for LeaderId<NID>

where NID: NodeId + Debug,

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

Formats the value using the given formatter.

impl<NID> Default for LeaderId<NID>

where NID: NodeId + Default,

fn default() -> LeaderId<NID>

Returns the “default value” for a type.

impl<'de, NID> Deserialize<'de> for LeaderId<NID>

where NID: NodeId,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<NID: NodeId> Display for LeaderId<NID>

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

Formats the value using the given formatter.

impl<NID: NodeId> From<Vote<NID>> for LeaderId<NID>

fn from(vote: Vote<NID>) -> Self

Converts to this type from the input type.

impl<NID> Ord for LeaderId<NID>

where NID: NodeId + Ord,

fn cmp(&self, other: &LeaderId<NID>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<NID> PartialEq for LeaderId<NID>

where NID: NodeId + PartialEq,

fn eq(&self, other: &LeaderId<NID>) -> 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> PartialOrd for LeaderId<NID>

where NID: NodeId + PartialOrd,

fn partial_cmp(&self, other: &LeaderId<NID>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<NID> Serialize for LeaderId<NID>

where NID: NodeId,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<NID> Copy for LeaderId<NID>

where NID: NodeId + Copy,

impl<NID> Eq for LeaderId<NID>

where NID: NodeId + Eq,

impl<NID> StructuralPartialEq for LeaderId<NID>

where NID: NodeId,