Struct openraft::Membership

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

The membership configuration of the cluster.

It could be a joint of one, two or more configs, i.e., a quorum is a node set that is superset of a majority of every config.

Implementations

impl<NID, N> Membership<NID, N>

where N: Node, NID: NodeId,

pub fn new<T>(config: Vec<BTreeSet<NID>>, nodes: T) -> Self

where T: IntoNodes<NID, N>,

Create a new Membership from a joint config of voter-ids and a collection of all Node(voter nodes and learner nodes).

A node id that is in nodes but is not in config is a learner.

A node presents in config but not in nodes is filled with default value.

The nodes can be:

• a simple (), if there are no learner nodes,
• BTreeSet<NodeId> provides learner node ids whose Node data are Node::default(),
• BTreeMap<NodeId, Node> provides nodes for every node id. Node ids that are not in configs are learners.

pub fn is_in_joint_consensus(&self) -> bool

👎Deprecated since 0.8.4: use get_joint_config().len() > 1 instead

Check to see if the config is currently in joint consensus.

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

Returns reference to the joint config.

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

The returned Vec contains one or more configs(currently it is two). If there is only one config, it is in a uniform config, otherwise, it is in a joint consensus.

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

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

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

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

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

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

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

Returns an Iterator of all learner node ids. Voters are not included.

Trait Implementations

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

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

fn clone(&self) -> Membership<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 Membership<NID, N>

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

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

Formats the value using the given formatter.

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

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

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

Returns the “default value” for a type.

impl<'de, NID, N> Deserialize<'de> for Membership<NID, N>

where N: Node, 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, N> Display for Membership<NID, N>

where N: Node, NID: NodeId,

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

Formats the value using the given formatter.

impl<NID, N> From<BTreeMap<NID, N>> for Membership<NID, N>

where N: Node, NID: NodeId,

fn from(b: BTreeMap<NID, N>) -> Self

Converts to this type from the input type.

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

where N: Node, NID: NodeId,

fn summary(&self) -> String

Return a string of a big message

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

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

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

where N: Node, 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, N> Eq for Membership<NID, N>

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

impl<NID, N> StructuralPartialEq for Membership<NID, N>

where N: Node, NID: NodeId,