Struct Context 

pub struct Context<D: Digest, P: PublicKey> {
    pub round: Round,
    pub leader: P,
    pub parent: (View, D),
}

Context is a collection of metadata from consensus about a given payload. It provides information about the current epoch/view and the parent payload that new proposals are built on.

Fields

round: Round

Current round of consensus.

leader: P

Leader of the current round.

parent: (View, D)

Parent the payload is built on.

When the current view is not a term start, the parent must be the immediately previous view. When the current view is a term start, the parent may be an older certified view as long as the participant possesses nullifications covering every skipped term (a nullification covers the view it was created for and the remainder of that term); any uncovered view may eventually be finalized and skipping it would result in a fork. A certified parent remains valid even if a later nullification in its own term covers the parent view.

A pipelined handoff request instead names the previous view as its parent before that view certifies (see crate::CertifiableAutomaton::prepare).

A certified parent may never be finalized. Later proposals can skip it once a nullification covers its view, and a competing payload can then be finalized in its place. Only treat the parent as final once the Reporter receives an Activity::Finalization for it or one of its descendants.

Trait Implementations

impl<D: Clone + Digest, P: Clone + PublicKey> Clone for Context<D, P>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug + Digest, P: Debug + PublicKey> Debug for Context<D, P>

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

Formats the value using the given formatter.

impl<D: Digest, P: PublicKey> EncodeSize for Context<D, P>

fn encode_size(&self) -> usize

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

fn encode_inline_size(&self) -> usize

Returns the encoded size excluding bytes passed to BufsMut::push during Write::write_bufs. Used to size the fixed working buffer for inline writes, so it must not be less than the bytes written inline. Override alongside Write::write_bufs for types where large byte fields go via push, or the working buffer will over-allocate.

impl<D: Digest, P: PublicKey> Epochable for Context<D, P>

fn epoch(&self) -> Epoch

Returns the epoch associated with this object.

impl<D: Eq + Digest, P: Eq + PublicKey> Eq for Context<D, P>

impl<D: Digest, P: PublicKey> MaxEncodeSize for Context<D, P>

const MAX_ENCODE_SIZE: usize

An upper bound on the encoded size, in bytes.

impl<D: PartialEq + Digest, P: PartialEq + PublicKey> PartialEq for Context<D, P>

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

Equality operator ==.

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

Inequality operator !=.

impl<D: Digest, P: PublicKey> Read for Context<D, P>

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<D: PartialEq + Digest, P: PartialEq + PublicKey> StructuralPartialEq for Context<D, P>

impl<D: Digest, P: PublicKey> Viewable for Context<D, P>

fn view(&self) -> View

Returns the view associated with this object.

impl<D: Digest, P: PublicKey> Write for Context<D, P>

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

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

fn write_bufs(&self, buf: &mut impl BufsMut)

Writes to a BufsMut, allowing existing byte chunks to be appended via BufsMut::push instead of written inline. Must encode to the same format as Write::write. Defaults to Write::write.