Struct sp_npos_elections::Voter

pub struct Voter<AccountId> { /* private fields */ }

A voter entity.

Implementations

impl<AccountId: IdentifierT> Voter<AccountId>

pub fn new(who: AccountId) -> Self

Create a new Voter.

pub fn votes_for(&self, target: &AccountId) -> bool

Returns true if self votes for target.

Note that this does not take into account if target is elected (i.e. is active) or not.

pub fn into_assignment<P: PerThing>(self) -> Option<Assignment<AccountId, P>>

Returns none if this voter does not have any non-zero distributions.

Note that this might create un-normalized assignments, due to accuracy loss of P. Call site might compensate by calling normalize() on the returned Assignment as a post-processing.

pub fn try_normalize(&mut self) -> Result<(), &'static str>

Try and normalize the votes of self.

If the normalization is successful then Ok(()) is returned.

Note that this will not distinguish between elected and unelected edges. Thus, it should only be called on a voter who has already been reduced to only elected edges.

Errors

This will return only if the internal normalize fails. This can happen if the sum of the weights exceeds ExtendedBalance::max_value().

pub fn try_normalize_elected(&mut self) -> Result<(), &'static str>

Same as Self::try_normalize but the normalization is only limited between elected edges.

pub fn budget(&self) -> ExtendedBalance

This voter’s budget

Trait Implementations

impl<AccountId: Clone> Clone for Voter<AccountId>

fn clone(&self) -> Voter<AccountId>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: IdentifierT> Debug for Voter<A>

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

Formats the value using the given formatter.

impl<AccountId: Default> Default for Voter<AccountId>

fn default() -> Voter<AccountId>

Returns the “default value” for a type.