Enum openraft::ChangeMembers

pub enum ChangeMembers<NID: NodeId, N: Node> {
    AddVoterIds(BTreeSet<NID>),
    AddVoters(BTreeMap<NID, N>),
    RemoveVoters(BTreeSet<NID>),
    ReplaceAllVoters(BTreeSet<NID>),
    AddNodes(BTreeMap<NID, N>),
    SetNodes(BTreeMap<NID, N>),
    RemoveNodes(BTreeSet<NID>),
    ReplaceAllNodes(BTreeMap<NID, N>),
}

Defines various actions to change the membership, including adding or removing learners or voters.

Variants

AddVoterIds(BTreeSet<NID>)

Upgrade learners to voters.

The learners have to present or error::LearnerNotFound error will be returned.

AddVoters(BTreeMap<NID, N>)

Add voters with corresponding nodes.

RemoveVoters(BTreeSet<NID>)

Remove voters, leave removed voters as learner or not.

ReplaceAllVoters(BTreeSet<NID>)

Replace voter ids with a new set. The node of every new voter has to already be a learner.

AddNodes(BTreeMap<NID, N>)

Add nodes to membership, as learners.

it WONT replace existing node.

Prefer using this variant instead of SetNodes whenever possible, as AddNodes ensures safety, whereas incorrect usage of SetNodes can result in a brain split. See: Update-Node

SetNodes(BTreeMap<NID, N>)

Add or replace nodes in membership config.

it WILL replace existing node.

Prefer using AddNodes instead of SetNodes whenever possible, as AddNodes ensures safety, whereas incorrect usage of SetNodes can result in a brain split. See: Update-Node

RemoveNodes(BTreeSet<NID>)

Remove nodes from membership.

If a node is still a voter, it returns error::LearnerNotFound error.

ReplaceAllNodes(BTreeMap<NID, N>)

Replace all nodes with a new set.

Every voter has to have a corresponding node in the new set, otherwise it returns error::LearnerNotFound error.

Trait Implementations

impl<NID: Clone + NodeId, N: Clone + Node> Clone for ChangeMembers<NID, N>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<NID: Debug + NodeId, N: Debug + Node> Debug for ChangeMembers<NID, N>

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

Formats the value using the given formatter.

impl<'de, NID: NodeId, N: Node> Deserialize<'de> for ChangeMembers<NID, N>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<NID, N, I> From<I> for ChangeMembers<NID, N>

where NID: NodeId, N: Node, I: IntoIterator<Item = NID>,

Convert a series of ids to a Replace operation.

fn from(r: I) -> Self

Converts to this type from the input type.

impl<NID: PartialEq + NodeId, N: PartialEq + Node> PartialEq for ChangeMembers<NID, N>

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<NID: Eq + NodeId, N: Eq + Node> Eq for ChangeMembers<NID, N>

impl<NID: NodeId, N: Node> StructuralPartialEq for ChangeMembers<NID, N>