Struct wybr::outcome::GenericOutcome

pub struct GenericOutcome<'a> { /* fields omitted */ }

Multi-winner election outcome

Methods

impl<'a> GenericOutcome<'a>

pub fn new<I, J>(
    winners: I,
    withdrawn: J,
    candidates: u32,
    sealed: bool,
    meta: &'a Metadata
) -> GenericOutcome<'a> where
    I: IntoIterator<Item = u32>,
    J: IntoIterator<Item = u32>, 

Trait Implementations

impl<'a> Outcome for GenericOutcome<'a>

fn meta(&self) -> &Metadata

Reference to the election metadata

fn deterministic(&self) -> bool

Specify whether the election was deterministic

fn candidate_count(&self) -> usize

fn elected_count(&self) -> usize

Important traits for CandidateIterator<'a>

impl<'a> Iterator for CandidateIterator<'a> type Item = u32;

fn elected(&self) -> CandidateIterator

Return iterator of IDs of elected candidates

fn winner(&self) -> Option<u32>

Return a single winner ID, if there is one, that is either the election scheme is single winner one or there is one seat in multi-winner election

fn withdrawn_count(&self) -> usize

Important traits for CandidateIterator<'a>

impl<'a> Iterator for CandidateIterator<'a> type Item = u32;

fn withdrawn(&self) -> CandidateIterator

Return iterator of IDs of withdrawn candidates

Important traits for NamesIterator<'a>

impl<'a> Iterator for NamesIterator<'a> type Item = String;

fn elected_names(&self) -> NamesIterator

Return iterator of elected candidate names

fn winner_name(&self) -> Option<String>

Important traits for NamesIterator<'a>

impl<'a> Iterator for NamesIterator<'a> type Item = String;

fn withdrawn_names(&self) -> NamesIterator

Return iterator of names of withdrawn candidates

impl<'a> Debug for GenericOutcome<'a>

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

Formats the value using the given formatter.

impl<'a> Display for GenericOutcome<'a>

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

Formats the value using the given formatter.