Enum Handoff 

pub enum Handoff<D> {
    Vote(D),
    Stage(D),
    Wait,
}

An application’s response to a handoff proposal request.

Handoff<()> is the same decision without a payload, and map attaches one.

Variants

Vote(D)

Relay the candidate and cast the proposer’s notarize vote without waiting for the parent to certify.

This trusts the outgoing leader not to equivocate and to complete its term, since the proposal is usable only if every uncertified view it builds on certifies.

Validators buffer the early vote only once it is inside their admission window, which always includes the next term start from the parent’s term (see Optimistic Validation), and consensus does not resend it. If the quorum needs a validator whose window does not reach the vote yet, the incoming term times out.

Stage(D)

Relay the candidate and withhold the proposer’s notarize vote until its parent certifies or finalizes.

The relay commits to nothing: only the vote names a proposal. If the parent is replaced before it certifies, the proposer can relay another candidate for the same view.

A relay may defer sending the candidate until consensus requests the broadcast that precedes the proposer’s vote.

Wait

Request an ordinary proposal after the parent certifies.

Implementations

impl<D> Handoff<D>

pub const fn is_wait(&self) -> bool

Returns whether this response declines to build.

pub fn map<T>(self, f: impl FnOnce(D) -> T) -> Handoff<T>

Applies f to the payload, keeping the decision.

Trait Implementations

impl<D: Clone> Clone for Handoff<D>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Copy> Copy for Handoff<D>

impl<D: Debug> Debug for Handoff<D>

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

Formats the value using the given formatter.

impl<D: Eq> Eq for Handoff<D>

impl<D: PartialEq> PartialEq for Handoff<D>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<D: PartialEq> StructuralPartialEq for Handoff<D>