Struct sunshine_util::vote::VoteState

pub struct VoteState<Signal, BlockNumber, Hash> { /* fields omitted */ }

The state of an ongoing vote

Implementations

impl<Signal: Parameter + Copy + From<u32> + Default + Add<Output = Signal> + Sub<Output = Signal> + PartialOrd, BlockNumber: Parameter + Copy + Default, Hash: Clone> VoteState<Signal, BlockNumber, Hash>

pub fn new(
    topic: Option<Hash>,
    all_possible_turnout: Signal,
    passage_threshold: Signal,
    rejection_threshold: Option<Signal>,
    initialized: BlockNumber,
    expires: Option<BlockNumber>
) -> VoteState<Signal, BlockNumber, Hash>

pub fn new_unanimous_consent(
    topic: Option<Hash>,
    all_possible_turnout: Signal,
    initialized: BlockNumber,
    expires: Option<BlockNumber>
) -> VoteState<Signal, BlockNumber, Hash>

pub fn topic(&self) -> Option<Hash>

pub fn in_favor(&self) -> Signal

pub fn against(&self) -> Signal

pub fn turnout(&self) -> Signal

pub fn all_possible_turnout(&self) -> Signal

pub fn expires(&self) -> Option<BlockNumber>

pub fn passage_threshold(&self) -> Signal

pub fn rejection_threshold(&self) -> Option<Signal>

pub fn outcome(&self) -> VoteOutcome

pub fn update_topic_and_clear_state(&self, new_topic: Hash) -> Self

pub fn update_topic_without_clearing_state(&self, new_topic: Hash) -> Self

Trait Implementations

impl<Signal: Parameter + Copy + From<u32> + Default + Add<Output = Signal> + Sub<Output = Signal> + PartialOrd, Hash: Clone, BlockNumber: Parameter + Copy + Default> Apply<Signal, VoterView> for VoteState<Signal, BlockNumber, Hash>

fn apply(
    &self,
    magnitude: Signal,
    old_direction: VoterView,
    new_direction: VoterView
) -> Option<VoteState<Signal, BlockNumber, Hash>>

impl<Signal: Parameter + Copy + From<u32> + Default + PartialOrd + Add<Output = Signal> + Sub<Output = Signal>, BlockNumber: Parameter + Copy + Default, Hash: Clone> Approved for VoteState<Signal, BlockNumber, Hash>

fn approved(&self) -> bool

impl<Signal: Clone, BlockNumber: Clone, Hash: Clone> Clone for VoteState<Signal, BlockNumber, Hash>

fn clone(&self) -> VoteState<Signal, BlockNumber, Hash>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Signal, BlockNumber, Hash> Debug for VoteState<Signal, BlockNumber, Hash> where
    Signal: Debug,
    BlockNumber: Debug,
    Hash: Debug, 

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

Formats the value using the given formatter.

impl<Signal, BlockNumber, Hash> Decode for VoteState<Signal, BlockNumber, Hash> where
    Option<Hash>: Decode,
    Option<Hash>: Decode,
    Signal: Decode,
    Signal: Decode,
    Signal: Decode,
    Signal: Decode,
    Signal: Decode,
    Signal: Decode,
    Signal: Decode,
    Signal: Decode,
    Signal: Decode,
    Signal: Decode,
    Option<Signal>: Decode,
    Option<Signal>: Decode,
    BlockNumber: Decode,
    BlockNumber: Decode,
    Option<BlockNumber>: Decode,
    Option<BlockNumber>: Decode, 

fn decode<DecIn: Input>(input: &mut DecIn) -> Result<Self, Error>

Attempt to deserialise the value from input.

impl<Signal: Parameter + Copy + From<u32> + Default + Add<Output = Signal> + Sub<Output = Signal>, BlockNumber: Parameter + Copy + Default, Hash: Clone> Default for VoteState<Signal, BlockNumber, Hash>

fn default() -> VoteState<Signal, BlockNumber, Hash>

Returns the "default value" for a type.

impl<Signal, BlockNumber, Hash> Encode for VoteState<Signal, BlockNumber, Hash> where
    Option<Hash>: Encode,
    Option<Hash>: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Option<Signal>: Encode,
    Option<Signal>: Encode,
    BlockNumber: Encode,
    BlockNumber: Encode,
    Option<BlockNumber>: Encode,
    Option<BlockNumber>: Encode, 

fn encode_to<EncOut: Output>(&self, dest: &mut EncOut)

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

fn size_hint(&self) -> usize

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

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

Convert self to an owned vector.

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.

impl<Signal, BlockNumber, Hash> EncodeLike<VoteState<Signal, BlockNumber, Hash>> for VoteState<Signal, BlockNumber, Hash> where
    Option<Hash>: Encode,
    Option<Hash>: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Signal: Encode,
    Option<Signal>: Encode,
    Option<Signal>: Encode,
    BlockNumber: Encode,
    BlockNumber: Encode,
    Option<BlockNumber>: Encode,
    Option<BlockNumber>: Encode, 

impl<Signal: Eq, BlockNumber: Eq, Hash: Eq> Eq for VoteState<Signal, BlockNumber, Hash>

impl<Signal: PartialEq, BlockNumber: PartialEq, Hash: PartialEq> PartialEq<VoteState<Signal, BlockNumber, Hash>> for VoteState<Signal, BlockNumber, Hash>

fn eq(&self, other: &VoteState<Signal, BlockNumber, Hash>) -> bool

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

fn ne(&self, other: &VoteState<Signal, BlockNumber, Hash>) -> bool

This method tests for !=.

impl<Signal: Parameter + Copy + From<u32> + Default + PartialOrd + Add<Output = Signal> + Sub<Output = Signal>, BlockNumber: Parameter + Copy + Default, Hash: Clone> Rejected for VoteState<Signal, BlockNumber, Hash>

fn rejected(&self) -> Option<bool>

impl<Signal, BlockNumber, Hash> StructuralEq for VoteState<Signal, BlockNumber, Hash>

impl<Signal, BlockNumber, Hash> StructuralPartialEq for VoteState<Signal, BlockNumber, Hash>