Struct sp_election_providers::Assignment

pub struct Assignment<AccountId, P> where
    P: PerThing,  {
    pub who: AccountId,
    pub distribution: Vec<(AccountId, P), Global>,
}

A voter's stake assignment among a set of targets, represented as ratios.

Fields

who: AccountId

Voter's identifier.

distribution: Vec<(AccountId, P), Global>

The distribution of the voter's stake.

Implementations

impl<AccountId, P> Assignment<AccountId, P> where
    AccountId: IdentifierT,
    P: PerThing128, 

pub fn into_staked(self, stake: u128) -> StakedAssignment<AccountId>

Convert from a ratio assignment into one with absolute values aka. StakedAssignment.

It needs stake which is the total budget of the voter.

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

If an edge ratio is Bounded::min_value(), it is dropped. This edge can never mean anything useful.

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

Try and normalize this assignment.

If Ok(()) is returned, then the assignment MUST have been successfully normalized to 100%.

Errors

This will return only if the internal normalize fails. This can happen if sum of self.distribution.map(|p| p.deconstruct()) fails to fit inside UpperOf<P>. A user of this crate may statically assert that this can never happen and safely expect this to return Ok.

Trait Implementations

impl<AccountId, P> Clone for Assignment<AccountId, P> where
    AccountId: Clone,
    P: Clone + PerThing, 

pub fn clone(&self) -> Assignment<AccountId, P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<AccountId, P> Debug for Assignment<AccountId, P> where
    AccountId: Debug,
    P: PerThing + Debug, 

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

Formats the value using the given formatter.

impl<AccountId, P> Decode for Assignment<AccountId, P> where
    AccountId: Decode,
    P: PerThing,
    Vec<(AccountId, P), Global>: Decode, 

pub fn decode<__CodecInputEdqy>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Assignment<AccountId, P>, Error> where
    __CodecInputEdqy: Input, 

Attempt to deserialise the value from input.

pub fn skip<I>(input: &mut I) -> Result<(), Error> where
    I: Input, 

Attempt to skip the encoded value from input.

pub fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<AccountId, P> Default for Assignment<AccountId, P> where
    AccountId: Default,
    P: Default + PerThing, 

pub fn default() -> Assignment<AccountId, P>

Returns the "default value" for a type.

impl<AccountId, P> Encode for Assignment<AccountId, P> where
    AccountId: Encode,
    P: PerThing,
    Vec<(AccountId, P), Global>: Encode, 

pub fn encode_to<__CodecOutputEdqy>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
) where
    __CodecOutputEdqy: Output + ?Sized, 

Convert self to a slice and append it to the destination.

pub fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

pub fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

pub fn using_encoded<R, F>(&self, f: F) -> R where
    F: FnOnce(&[u8]) -> R, 

Convert self to a slice and then invoke the given closure with it.

pub fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<AccountId, P> EncodeLike<Assignment<AccountId, P>> for Assignment<AccountId, P> where
    AccountId: Encode,
    P: PerThing,
    Vec<(AccountId, P), Global>: Encode, 

impl<AccountId, P> Eq for Assignment<AccountId, P> where
    AccountId: Eq,
    P: Eq + PerThing, 

impl<AccountId, P> PartialEq<Assignment<AccountId, P>> for Assignment<AccountId, P> where
    AccountId: PartialEq<AccountId>,
    P: PartialEq<P> + PerThing, 

pub fn eq(&self, other: &Assignment<AccountId, P>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Assignment<AccountId, P>) -> bool

This method tests for !=.

impl<AccountId, P> StructuralEq for Assignment<AccountId, P> where
    P: PerThing, 

impl<AccountId, P> StructuralPartialEq for Assignment<AccountId, P> where
    P: PerThing,