Struct Epoch

pub struct Epoch(pub u64);

Epoch represents a Cardano epoch

Tuple Fields

0: u64

Implementations

impl Epoch

pub const SIGNER_RETRIEVAL_OFFSET: i64 = -1i64

The epoch offset used for signers stake distribution and verification keys retrieval.

pub const NEXT_SIGNER_RETRIEVAL_OFFSET: u64 = 0u64

The epoch offset used to retrieve the signers stake distribution and verification keys that’s currently being signed so it can be used in the next epoch.

pub const SIGNER_RECORDING_OFFSET: u64 = 1u64

The epoch offset used for signers stake distribution and verification keys recording.

pub const EPOCH_SETTINGS_RECORDING_OFFSET: u64 = 2u64

The epoch offset used for aggregator epoch settings recording.

pub const SIGNER_SIGNING_OFFSET: u64 = 2u64

The epoch offset used to retrieve, given the epoch at which a signer registered, the epoch at which the signer can send single signatures.

pub const CARDANO_STAKE_DISTRIBUTION_SNAPSHOT_OFFSET: u64 = 2u64

The epoch offset used to retrieve the epoch at the end of which the snapshot of the stake distribution was taken by the Cardano node and labeled as ‘Mark’ snapshot during the following epoch.

pub fn offset_by(&self, epoch_offset: i64) -> Result<Epoch, EpochError>

Computes a new Epoch by applying an epoch offset.

Will fail if the computed epoch is negative.

pub fn offset_to_signer_retrieval_epoch(&self) -> Result<Epoch, EpochError>

Apply the retrieval offset to this epoch

pub fn offset_to_next_signer_retrieval_epoch(&self) -> Epoch

Apply the next signer retrieval offset to this epoch

pub fn offset_to_recording_epoch(&self) -> Epoch

Apply the recording offset to this epoch

pub fn offset_to_epoch_settings_recording_epoch(&self) -> Epoch

Apply the epoch settings recording offset to this epoch

pub fn offset_to_signer_signing_offset(&self) -> Epoch

Apply the signer signing offset to this epoch

pub fn offset_to_cardano_stake_distribution_snapshot_epoch(&self) -> Epoch

Apply the cardano stake distribution snapshot epoch offset to this epoch

pub fn next(&self) -> Epoch

Computes the next Epoch

pub fn previous(&self) -> Result<Epoch, EpochError>

Computes the previous Epoch

pub fn has_gap_with(&self, other: &Epoch) -> bool

Check if there is a gap with another Epoch.

Methods from Deref<Target = u64>

pub const MIN: u64 = 0u64

pub const MAX: u64 = 18_446_744_073_709_551_615u64

pub const BITS: u32 = 64u32

Trait Implementations

impl Add<&Epoch> for &u64

type Output = Epoch

The resulting type after applying the + operator.

fn add(self, rhs: &Epoch) -> <&u64 as Add<&Epoch>>::Output

Performs the + operation.

impl Add<&Epoch> for u64

type Output = Epoch

The resulting type after applying the + operator.

fn add(self, rhs: &Epoch) -> <u64 as Add<&Epoch>>::Output

Performs the + operation.

impl Add<&u64> for Epoch

type Output = Epoch

The resulting type after applying the + operator.

fn add(self, rhs: &u64) -> <Epoch as Add<&u64>>::Output

Performs the + operation.

impl Add<Epoch> for &u64

type Output = Epoch

The resulting type after applying the + operator.

fn add(self, rhs: Epoch) -> <&u64 as Add<Epoch>>::Output

Performs the + operation.

impl Add<Epoch> for u64

type Output = Epoch

The resulting type after applying the + operator.

fn add(self, rhs: Epoch) -> <u64 as Add<Epoch>>::Output

Performs the + operation.

impl Add<u64> for Epoch

type Output = Epoch

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> <Epoch as Add<u64>>::Output

Performs the + operation.

impl Add for Epoch

type Output = Epoch

The resulting type after applying the + operator.

fn add(self, rhs: Epoch) -> <Epoch as Add>::Output

Performs the + operation.

impl AddAssign<&Epoch> for u64

fn add_assign(&mut self, rhs: &Epoch)

Performs the += operation.

impl AddAssign<&u64> for Epoch

fn add_assign(&mut self, rhs: &u64)

Performs the += operation.

impl AddAssign<Epoch> for u64

fn add_assign(&mut self, rhs: Epoch)

Performs the += operation.

impl AddAssign<u64> for Epoch

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl AddAssign for Epoch

fn add_assign(&mut self, rhs: Epoch)

Performs the += operation.

impl Clone for Epoch

fn clone(&self) -> Epoch

Returns a copy 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 Default for Epoch

fn default() -> Epoch

Returns the “default value” for a type.

impl Deref for Epoch

type Target = u64

The resulting type after dereferencing.

fn deref(&self) -> &<Epoch as Deref>::Target

Dereferences the value.

impl DerefMut for Epoch

fn deref_mut(&mut self) -> &mut <Epoch as Deref>::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Epoch

fn deserialize<__D>( __deserializer: __D, ) -> Result<Epoch, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Epoch

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

Formats the value using the given formatter.

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<&Epoch> 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 PartialEq<&Epoch> for u64

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 PartialEq<&u64> for Epoch

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

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 PartialEq<Epoch> for u64

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 PartialEq<u64> for &Epoch

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

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<&Epoch> for &u64

type Output = Epoch

The resulting type after applying the - operator.

fn sub(self, rhs: &Epoch) -> <&u64 as Sub<&Epoch>>::Output

Performs the - operation.

impl Sub<&Epoch> for u64

type Output = Epoch

The resulting type after applying the - operator.

fn sub(self, rhs: &Epoch) -> <u64 as Sub<&Epoch>>::Output

Performs the - operation.

impl Sub<&u64> for Epoch

type Output = Epoch

The resulting type after applying the - operator.

fn sub(self, rhs: &u64) -> <Epoch as Sub<&u64>>::Output

Performs the - operation.

impl Sub<Epoch> for &u64

type Output = Epoch

The resulting type after applying the - operator.

fn sub(self, rhs: Epoch) -> <&u64 as Sub<Epoch>>::Output

Performs the - operation.

impl Sub<Epoch> for u64

type Output = Epoch

The resulting type after applying the - operator.

fn sub(self, rhs: Epoch) -> <u64 as Sub<Epoch>>::Output

Performs the - operation.

impl Sub<u64> for Epoch

type Output = Epoch

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> <Epoch as Sub<u64>>::Output

Performs the - operation.

impl Sub for Epoch

type Output = Epoch

The resulting type after applying the - operator.

fn sub(self, rhs: Epoch) -> <Epoch as Sub>::Output

Performs the - operation.

impl SubAssign<&Epoch> for u64

fn sub_assign(&mut self, rhs: &Epoch)

Performs the -= operation.

impl SubAssign<&u64> for Epoch

fn sub_assign(&mut self, rhs: &u64)

Performs the -= operation.

impl SubAssign<Epoch> for u64

fn sub_assign(&mut self, rhs: Epoch)

Performs the -= operation.

impl SubAssign<u64> for Epoch

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.

impl SubAssign for Epoch

fn sub_assign(&mut self, rhs: Epoch)

Performs the -= operation.

impl TryInto<i64> for &Epoch

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<i64, <&Epoch as TryInto<i64>>::Error>

Performs the conversion.

impl TryInto<i64> for Epoch

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<i64, <Epoch as TryInto<i64>>::Error>

Performs the conversion.

impl Beacon for Epoch

impl Copy for Epoch

impl Eq for Epoch

impl StructuralPartialEq for Epoch