Struct sp_npos_elections::StakedAssignment

pub struct StakedAssignment<AccountId> {
    pub who: AccountId,
    pub distribution: Vec<(AccountId, ExtendedBalance)>,
}

A voter’s stake assignment among a set of targets, represented as absolute values in the scale of ExtendedBalance.

Fields

who: AccountId

Voter’s identifier

distribution: Vec<(AccountId, ExtendedBalance)>

The distribution of the voter’s stake.

Implementations

impl<AccountId> StakedAssignment<AccountId>

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

Converts self into the normal Assignment type.

NOTE: This will always round down, and thus the results might be less than a full 100% P. Use a normalization post-processing to fix this. The data type returned here will potentially get used to create a compact type; a compact type requires sum of ratios to be less than 100% upon un-compacting.

If an edge stake is so small that it cannot be represented in T, it is ignored. This edge can never be re-created and does not mean anything useful anymore.

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

Try and normalize this assignment.

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

NOTE: current implementation of .normalize is almost safe to expect() upon. The only error case is when the input cannot fit in T, or the sum of input cannot fit in T. Sadly, both of these are dependent upon the implementation of VoteLimit, i.e. the limit of edges per voter which is enforced from upstream. Hence, at this crate, we prefer returning a result and a use the name prefix try_.

pub fn total(&self) -> ExtendedBalance

Get the total stake of this assignment (aka voter budget).

Trait Implementations

impl<AccountId: Clone> Clone for StakedAssignment<AccountId>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<AccountId> Debug for StakedAssignment<AccountId>where
    AccountId: Debug,

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

Formats the value using the given formatter.

impl<AccountId> Decode for StakedAssignment<AccountId>where
    AccountId: Decode,
    Vec<(AccountId, ExtendedBalance)>: Decode,

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>(
    input: &mut I,
    dst: &mut MaybeUninit<Self>
) -> Result<DecodeFinished, Error>where
    I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

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

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<AccountId: Default> Default for StakedAssignment<AccountId>

fn default() -> StakedAssignment<AccountId>

Returns the “default value” for a type.

impl<AccountId> Encode for StakedAssignment<AccountId>where
    AccountId: Encode,
    Vec<(AccountId, ExtendedBalance)>: Encode,

fn size_hint(&self) -> usize

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

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

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

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

Convert self to an owned vector.

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

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

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<AccountId: PartialEq> PartialEq<StakedAssignment<AccountId>> for StakedAssignment<AccountId>

fn eq(&self, other: &StakedAssignment<AccountId>) -> 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<AccountId> EncodeLike<StakedAssignment<AccountId>> for StakedAssignment<AccountId>where
    AccountId: Encode,
    Vec<(AccountId, ExtendedBalance)>: Encode,

impl<AccountId: Eq> Eq for StakedAssignment<AccountId>

impl<AccountId> StructuralEq for StakedAssignment<AccountId>

impl<AccountId> StructuralPartialEq for StakedAssignment<AccountId>