Struct Round

pub struct Round(/* private fields */);

A type-safe consensus round number within a single epoch.

Implementations

impl Round

pub fn zero() -> Round

Creates a zero round (i.e. a state right after progressing to a next epoch).

pub fn of(number: u64) -> Round

Creates a round of the given number.

pub fn number(&self) -> u64

Returns a raw round number.

pub fn calculate_progress(from: Round, to: Round) -> Option<u64>

Returns a number of rounds between from and to, or None if there was no progress (i.e. their difference was not positive).

Trait Implementations

impl<X> Categorize<X> for Round

where X: CustomValueKind,

fn value_kind() -> ValueKind<X>

impl Clone for Round

fn clone(&self) -> Round

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Round

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

Formats the value using the given formatter.

impl<D, X> Decode<X, D> for Round

where D: Decoder<X>, X: CustomValueKind,

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<X>, ) -> Result<Round, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind.

impl<C> Describe<C> for Round

where C: CustomTypeKind<RustTypeId>,

const TYPE_ID: RustTypeId

The TYPE_ID should give a unique identifier for its SBOR schema type. An SBOR schema type capture details about the SBOR payload, how it should be interpreted, validated and displayed.

fn type_data() -> TypeData<C, RustTypeId>

Returns the local schema for the given type.

fn add_all_dependencies(aggregator: &mut TypeAggregator<C>)

For each type referenced in get_local_type_data, we need to ensure that the type and all of its own references get added to the aggregator.

impl<E, X> Encode<X, E> for Round

where E: Encoder<X>, X: CustomValueKind,

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder.

impl Hash for Round

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

where __H: Hasher,

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 PartialEq for Round

fn eq(&self, other: &Round) -> 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<X> SborEnum<X> for Round

where X: CustomValueKind, &'b_ u64: for<'b_> SborEnum<X>,

fn get_discriminator(&self) -> u8

fn get_length(&self) -> usize

impl<X> SborTuple<X> for Round

where X: CustomValueKind, &'b_ u64: for<'b_> SborTuple<X>,

fn get_length(&self) -> usize

impl Copy for Round

impl Eq for Round

impl StructuralPartialEq for Round