Struct parsec::Vote

pub struct Vote<T: NetworkEvent, P: PublicId> { /* fields omitted */ }

A helper struct carrying some data and a signature of this data.

Methods

impl<T: NetworkEvent, P: PublicId> Vote<T, P>

pub fn new<S: SecretId<PublicId = P>>(     secret_id: &S,     payload: T ) -> Result<Self, Error>

Creates a Vote for payload.

pub fn payload(&self) -> &T

Returns the payload being voted for.

pub fn signature(&self) -> &P::Signature

Returns the signature of this Vote's payload.

pub fn is_valid(&self, public_id: &P) -> bool

Validates this Vote's signature and payload against the given public ID.

pub fn create_proof(&self, public_id: &P) -> Result<Proof<P>, Error>

Creates a Proof from this Vote. Returns Err if this Vote is not valid (i.e. if !self.is_valid()).

Trait Implementations

impl<T: Clone + NetworkEvent, P: Clone + PublicId> Clone for Vote<T, P> where     P::Signature: Clone,

fn clone(&self) -> Vote<T, P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialEq + NetworkEvent, P: PartialEq + PublicId> PartialEq for Vote<T, P> where     P::Signature: PartialEq,

fn eq(&self, other: &Vote<T, P>) -> bool

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

fn ne(&self, other: &Vote<T, P>) -> bool

This method tests for !=.

impl<T: Eq + NetworkEvent, P: Eq + PublicId> Eq for Vote<T, P> where     P::Signature: Eq,

impl<T: PartialOrd + NetworkEvent, P: PartialOrd + PublicId> PartialOrd for Vote<T, P> where     P::Signature: PartialOrd,

fn partial_cmp(&self, other: &Vote<T, P>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Vote<T, P>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Vote<T, P>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Vote<T, P>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Vote<T, P>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Ord + NetworkEvent, P: Ord + PublicId> Ord for Vote<T, P> where     P::Signature: Ord,

fn cmp(&self, other: &Vote<T, P>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl<T: Debug + NetworkEvent, P: Debug + PublicId> Debug for Vote<T, P> where     P::Signature: Debug,

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

Formats the value using the given formatter.