Struct VoterSet

pub struct VoterSet<Id: Eq + Ord> { /* private fields */ }

A (non-empty) set of voters and associated weights.

A VoterSet identifies all voters that are permitted to vote in a round of the protocol and their associated weights. A VoterSet is furthermore equipped with a total order, given by the ordering of the voter’s IDs.

Implementations

impl<Id: Eq + Ord> VoterSet<Id>

pub fn new<I>(weights: I) -> Option<Self>

where Id: Ord + Clone, I: IntoIterator<Item = (Id, u64)>,

Create a voter set from a weight distribution produced by the given iterator.

If the distribution contains multiple weights for the same voter ID, they are understood to be partial weights and are accumulated. As a result, the order in which the iterator produces the weights is irrelevant.

Returns None if the iterator does not yield a valid voter set, which is the case if it either produced no non-zero weights or, i.e. the voter set would be empty, or if the total voter weight exceeds u64::MAX.

pub fn get(&self, id: &Id) -> Option<&VoterInfo>

Get the voter info for the voter with the given ID, if any.

pub fn len(&self) -> NonZeroUsize

Get the size of the set.

pub fn contains(&self, id: &Id) -> bool

Whether the set contains a voter with the given ID.

pub fn nth_mod(&self, n: usize) -> (&Id, &VoterInfo)

Get the nth voter in the set, modulo the size of the set, as per the associated total order.

pub fn nth(&self, n: usize) -> Option<(&Id, &VoterInfo)>

Get the nth voter in the set, if any.

Returns None if n >= len.

pub fn threshold(&self) -> VoterWeight

Get the threshold vote weight required for supermajority w.r.t. this set of voters.

pub fn total_weight(&self) -> VoterWeight

Get the total weight of all voters.

pub fn iter(&self) -> impl Iterator<Item = (&Id, &VoterInfo)>

Get an iterator over the voters in the set, as given by the associated total order.

Trait Implementations

impl<Id: Clone + Eq + Ord> Clone for VoterSet<Id>

fn clone(&self) -> VoterSet<Id>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Id: Debug + Eq + Ord> Debug for VoterSet<Id>

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

Formats the value using the given formatter.

impl<Id: PartialEq + Eq + Ord> PartialEq for VoterSet<Id>

fn eq(&self, other: &VoterSet<Id>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Id: Eq + Eq + Ord> Eq for VoterSet<Id>

impl<Id: Eq + Ord> StructuralPartialEq for VoterSet<Id>