Struct openraft::EffectiveMembership

pub struct EffectiveMembership<NID, N>
where
    N: Node,
    NID: NodeId,
{ /* private fields */ }

The currently active membership config.

It includes:

• the id of the log that sets this membership config,
• and the config.

An active config is just the last seen config in raft spec.

Implementations

impl<NID, N> EffectiveMembership<NID, N>

where N: Node, NID: NodeId,

pub fn new(log_id: Option<LogId<NID>>, membership: Membership<NID, N>) -> Self

pub fn log_id(&self) -> &Option<LogId<NID>>

pub fn membership(&self) -> &Membership<NID, N>

impl<NID, N> EffectiveMembership<NID, N>

where N: Node, NID: NodeId,

Membership API

pub fn voter_ids(&self) -> impl Iterator<Item = NID> + '_

Returns an Iterator of all voter node ids. Learners are not included.

pub fn get_node(&self, node_id: &NID) -> Option<&N>

Get a the node(either voter or learner) by node id.

pub fn nodes(&self) -> impl Iterator<Item = (&NID, &N)>

Returns an Iterator of all nodes(voters and learners).

pub fn get_joint_config(&self) -> &Vec<Vec<NID>>

Returns reference to the joint config.

Membership is defined by a joint of multiple configs. Each config is a vec of node-id.

Trait Implementations

impl<NID, N> Clone for EffectiveMembership<NID, N>

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<NID, N> Debug for EffectiveMembership<NID, N>

where N: Node, NID: NodeId,

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

Formats the value using the given formatter.

impl<NID, N> Default for EffectiveMembership<NID, N>

where N: Node + Default, NID: NodeId + Default,

fn default() -> EffectiveMembership<NID, N>

Returns the “default value” for a type.

impl<NID, N, LID> From<(&LID, Membership<NID, N>)> for EffectiveMembership<NID, N>

where N: Node, NID: NodeId, LID: RaftLogId<NID>,

fn from(v: (&LID, Membership<NID, N>)) -> Self

Converts to this type from the input type.

impl<NID, N> MessageSummary<EffectiveMembership<NID, N>> for EffectiveMembership<NID, N>

where N: Node, NID: NodeId,

fn summary(&self) -> String

Return a string of a big message

impl<NID, N> PartialEq for EffectiveMembership<NID, N>

where N: Node, NID: NodeId,

fn eq(&self, other: &Self) -> 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> Eq for EffectiveMembership<NID, N>

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