Struct Finalize 

pub struct Finalize<S: Scheme, D: Digest> {
    pub proposal: Proposal<D>,
    pub vote: Vote<S>,
}

Validator vote to finalize a proposal. This happens after a proposal has been notarized, confirming it as the canonical block for this round.

Fields

proposal: Proposal<D>

Proposal being finalized.

vote: Vote<S>

Scheme-specific vote material.

Implementations

impl<S: Scheme, D: Digest> Finalize<S, D>

pub fn round(&self) -> Round

Returns the round associated with this finalize vote.

impl<S: Scheme, D: Digest> Finalize<S, D>

pub fn sign(scheme: &S, namespace: &[u8], proposal: Proposal<D>) -> Option<Self>

Signs a finalize vote for the provided proposal.

pub fn verify(&self, scheme: &S, namespace: &[u8]) -> bool

Verifies the finalize vote against the provided signing scheme.

This ensures that the finalize signature is valid for the claimed proposal.

Trait Implementations

impl<S: Scheme, D: Digest> Attributable for Finalize<S, D>

fn signer(&self) -> u32

Returns the index of the signer (validator) who produced this message.

impl<S: Clone + Scheme, D: Clone + Digest> Clone for Finalize<S, D>

fn clone(&self) -> Finalize<S, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + Scheme, D: Debug + Digest> Debug for Finalize<S, D>

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

Formats the value using the given formatter.

impl<S: Scheme, D: Digest> EncodeSize for Finalize<S, D>

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).

impl<S: Scheme, D: Digest> Epochable for Finalize<S, D>

type Epoch = u64

Epoch is the type used to indicate a contiguous sequence of views in which the set of validators is constant.

fn epoch(&self) -> Epoch

Returns the epoch associated with this object.

impl<S: Scheme, D: Digest> Hash for Finalize<S, D>

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<S: Scheme, D: Digest> PartialEq for Finalize<S, D>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: Scheme, D: Digest> Read for Finalize<S, D>

type Cfg = ()

The Cfg type parameter allows passing configuration during the read process. This is crucial for safely decoding untrusted data, for example, by providing size limits for collections or strings.

fn read_cfg(reader: &mut impl Buf, _: &()) -> Result<Self, Error>

Reads a value from the buffer using the provided configuration cfg.

impl<S: Scheme, D: Digest> Viewable for Finalize<S, D>

type View = u64

View is the type used to indicate the in-progress consensus decision.

fn view(&self) -> View

Returns the view associated with this object.

impl<S: Scheme, D: Digest> Write for Finalize<S, D>

fn write(&self, writer: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf.

impl<S: Scheme, D: Digest> Eq for Finalize<S, D>