Struct Terms 

pub struct Terms { /* private fields */ }

Leadership term structure reported by an Elector.

Implementations

impl Terms

pub const fn rotating() -> Self

Every view is its own term: a new leader is elected each view, and leader rotation itself bounds how long finality can stall.

pub const fn stable( length: TermLength, stall_timeout: Duration, optimistic_views: ViewDelta, ) -> Self

Views are grouped into terms of length consecutive views served by one leader.

The length is consensus-critical: every participant must configure the same value (see TermLength).

stall_timeout is local policy: the maximum time an entered view may remain unfinalized before this participant abandons the term. On expiry it treats its current view as timed out and votes nullify, which (with a quorum) forms a nullification covering the rest of the term and evicts the leader.

A Byzantine stable leader can keep every per-view timer satisfied while preventing finality: each view notarizes and certifies, but no finalization certificate forms. With single-view terms, leader rotation bounds such a stall to one view. With longer terms, this timeout bounds it instead.

optimistic_views is how far a participant may optimistically run ahead of certified ancestry within a term; zero disables optimistic validation entirely, and values wider than length are accepted but capped by the windows themselves. The voter tracks a round for every optimistic view, so memory scales with the smaller of optimistic_views and length. See Optimistic Validation for the exact window, which anchors at the last directly notarized view. Like the stall timeout, this is local policy: mismatched values across participants only degrade the optimization, never safety.

Panics

Panics if length is 1 or if stall_timeout is zero. Single-view terms are Terms::rotating (the default), where per-view timeouts already bound a stall and no optimistic window exists.

pub const fn length(&self) -> TermLength

Returns the number of consecutive views per term.

Returns TermLength::ONE if and only if this is Terms::rotating. A length of one is the definition of rotation, not an approximation of it: all term arithmetic (View::covers, View::admits, View::term_index, View::next_term_start) reduces exactly to per-view behavior at length one. The only regime fact the length does not carry is the stall deadline, which callers read from Terms::stall_timeout.

pub const fn stall_timeout(&self) -> Option<Duration>

Returns the term-abandonment timeout, if stable leaders are configured.

Returns Some if and only if Self::length is greater than one.

pub const fn optimistic_views(&self) -> ViewDelta

Returns the optimistic intra-term lookahead (see Terms::stable).

Always zero when Self::length is one.

Trait Implementations

impl Clone for Terms

fn clone(&self) -> Terms

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Terms

impl Debug for Terms

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

Formats the value using the given formatter.

impl Default for Terms

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Terms

impl PartialEq for Terms

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Terms