Struct Validators

pub struct Validators<VID>
where
    VID: Eq + Hash,
{ /* private fields */ }

The validator IDs and weight map.

Implementations

impl<VID: Eq + Hash> Validators<VID>

pub fn total_weight(&self) -> Weight

Returns the total weight of the set of validators.

pub fn weight(&self, idx: ValidatorIndex) -> Weight

Returns the weight of the validator with the given index.

Panics if the validator index does not exist.

pub fn is_empty(&self) -> bool

Returns true if the map is empty.

pub fn len(&self) -> usize

Returns the number of validators.

pub fn get_index(&self, id: &VID) -> Option<ValidatorIndex>

Gets the index of a validator with the given ID. Returns None if no such validator is in the set.

pub fn id(&self, idx: ValidatorIndex) -> Option<&VID>

Returns validator ID by index, or None if it doesn’t exist.

pub fn iter(&self) -> impl Iterator<Item = &Validator<VID>>

Returns an iterator over all validators, sorted by ID.

pub fn ban(&mut self, vid: &VID)

Marks the validator with that ID as banned, if it exists, and excludes it from the leader sequence.

pub fn set_cannot_propose(&mut self, vid: &VID)

Marks the validator as excluded from the leader sequence.

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

Returns an iterator of all indices of banned validators.

pub fn iter_cannot_propose_idx( &self, ) -> impl Iterator<Item = ValidatorIndex> + '_

Returns an iterator of all indices of validators that are not allowed to propose values.

pub fn enumerate_ids<'a>( &'a self, ) -> impl Iterator<Item = (ValidatorIndex, &'a VID)>

Returns an iterator of pairs (validator index, validator ID).

Trait Implementations

impl<VID> Clone for Validators<VID>

where VID: Eq + Hash + Clone,

fn clone(&self) -> Validators<VID>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<VID> DataSize for Validators<VID>

where HashMap<VID, ValidatorIndex>: DataSize, Vec<Validator<VID>>: DataSize, VID: Eq + Hash,

const IS_DYNAMIC: bool

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

fn estimate_detailed_heap_size(&self) -> MemUsageNode

Create a tree of memory estimations.

impl<VID> Debug for Validators<VID>

where VID: Eq + Hash + Debug,

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

Formats the value using the given formatter.

impl<VID: Ord + Hash + Debug> Display for Validators<VID>

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

Formats the value using the given formatter.

impl<VID: Ord + Hash + Clone, W: Into<Weight>> FromIterator<(VID, W)> for Validators<VID>

fn from_iter<I: IntoIterator<Item = (VID, W)>>(ii: I) -> Validators<VID>

Creates a value from an iterator.