Struct TimeoutBallot 

pub struct TimeoutBallot<T: NodeType> {
    vote: TimeoutVote3<T>,
    lock: Option<Certificate1<T>>,
}

A timeout vote that signs its signer’s lock, with the certificate of that lock.

The lock the vote signs is the certificate’s, so the two always agree; None is a signer locked on nothing but genesis. A ballot can only be signed by its own signer (Self::sign) or read from a message (TimeoutVoteMessage3::ballot), and neither checks the signatures.

Fields

vote: TimeoutVote3<T>

lock: Option<Certificate1<T>>

Implementations

impl<T: NodeType> TimeoutBallot<T>

pub fn sign( view: ViewNumber, epoch: EpochNumber, lock: Option<Certificate1<T>>, public_key: &T::SignatureKey, private_key: &<T::SignatureKey as SignatureKey>::PrivateKey, upgrade_lock: &UpgradeLock<T>, ) -> Result<Self>

Sign a timeout vote for view in epoch naming the lock lock certifies.

pub fn vote(&self) -> &TimeoutVote3<T>

The signed vote.

pub fn lock(&self) -> Option<&Certificate1<T>>

The certificate of the lock the vote signs.

pub fn timeout_lock(&self) -> TimeoutLock<'_, T>

The lock the vote signs, by what is checked of it.

Trait Implementations

impl<T: NodeType> Ballot for TimeoutBallot<T>

fn epochs(&self) -> impl Iterator<Item = EpochNumber>

Its own epoch, and its lock’s if the lock is recent: the lock certificate is verified against that epoch’s committee.

type Signer = <T as NodeType>::SignatureKey

fn view(&self) -> ViewNumber

fn epoch(&self) -> Option<EpochNumber>

fn signer(&self) -> Self::Signer

impl<T: Clone + NodeType> Clone for TimeoutBallot<T>

fn clone(&self) -> TimeoutBallot<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + NodeType> Debug for TimeoutBallot<T>

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

Formats the value using the given formatter.

impl<T: Eq + NodeType> Eq for TimeoutBallot<T>

impl<T: Hash + NodeType> Hash for TimeoutBallot<T>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq + NodeType> PartialEq for TimeoutBallot<T>

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: PartialEq + NodeType> StructuralPartialEq for TimeoutBallot<T>