Struct Epoch

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

A type-safe consensus epoch number.

Implementations

impl Epoch

pub fn zero() -> Epoch

Creates a zero epoch (i.e. pre-genesis).

pub fn of(number: u64) -> Epoch

Creates an epoch of the given number.

pub fn number(&self) -> u64

Returns a raw epoch number.

pub fn next(&self) -> Option<Epoch>

Creates an epoch immediately following this one. Returns None if this epoch’s number is u64::MAX (such situation would indicate a bug or a deliberate harm meant by byzantine actors, since regular epoch progression should not reach such numbers within next thousands of years).

pub fn after(&self, epoch_count: u64) -> Option<Epoch>

Creates an epoch following this one after the given number of epochs. Returns None if the resulting number is greater than u64::MAX (such situation would indicate a bug or a deliberate harm meant by byzantine actors, since regular epoch delays configured by a network should not span thousands of years).

pub fn previous(&self) -> Option<Epoch>

Creates an epoch immediately preceding this one. Returns None if this epoch’s number is 0 (such situation would indicate a bug or a deliberate harm, since a legitimate genesis should not reference previous epochs).

Trait Implementations

impl<X> Categorize<X> for Epoch

where X: CustomValueKind,

fn value_kind() -> ValueKind<X>

impl Clone for Epoch

fn clone(&self) -> Epoch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Epoch

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

Formats the value using the given formatter.

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

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

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

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

impl<C> Describe<C> for Epoch

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 Epoch

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 Epoch

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 Ord for Epoch

fn cmp(&self, other: &Epoch) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Epoch

fn eq(&self, other: &Epoch) -> 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 PartialOrd for Epoch

fn partial_cmp(&self, other: &Epoch) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<X> SborEnum<X> for Epoch

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

fn get_discriminator(&self) -> u8

fn get_length(&self) -> usize

impl<X> SborTuple<X> for Epoch

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

fn get_length(&self) -> usize

impl Copy for Epoch

impl Eq for Epoch

impl StructuralPartialEq for Epoch