Struct parsec::Vote

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

A helper struct carrying an Observation and a signature of this Observation.

Implementations

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

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

Creates a Vote for payload.

pub fn payload(&self) -> &Observation<T, P>

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, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<'de, T: NetworkEvent, P: PublicId> Deserialize<'de> for Vote<T, P> where
    T: DeserializeOwned, 

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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

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

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

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

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=.

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

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

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

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

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

pub 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.

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

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

pub 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: NetworkEvent, P: PublicId> Serialize for Vote<T, P> where
    T: Serialize,
    P: Serialize,
    P::Signature: Serialize, 

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

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

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