Struct ckb_types::core::EpochNumberWithFraction

pub struct EpochNumberWithFraction(_);

Represents an epoch number with a fraction unit, it can be used to accurately represent the position for a block within an epoch.

Implementations

impl EpochNumberWithFraction

pub const NUMBER_OFFSET: usize = 0usize

TODO(doc): @quake

pub const NUMBER_BITS: usize = 24usize

TODO(doc): @quake

pub const NUMBER_MAXIMUM_VALUE: u64 = 16_777_216u64

TODO(doc): @quake

pub const NUMBER_MASK: u64 = 16_777_215u64

TODO(doc): @quake

pub const INDEX_OFFSET: usize = 24usize

TODO(doc): @quake

pub const INDEX_BITS: usize = 16usize

TODO(doc): @quake

pub const INDEX_MAXIMUM_VALUE: u64 = 65_536u64

TODO(doc): @quake

pub const INDEX_MASK: u64 = 65_535u64

TODO(doc): @quake

pub const LENGTH_OFFSET: usize = 40usize

TODO(doc): @quake

pub const LENGTH_BITS: usize = 16usize

TODO(doc): @quake

pub const LENGTH_MAXIMUM_VALUE: u64 = 65_536u64

TODO(doc): @quake

pub const LENGTH_MASK: u64 = 65_535u64

TODO(doc): @quake

pub fn new(number: u64, index: u64, length: u64) -> EpochNumberWithFraction

TODO(doc): @quake

pub const fn new_unchecked(number: u64, index: u64, length: u64) -> Self

TODO(doc): @quake

pub fn number(self) -> EpochNumber

TODO(doc): @quake

pub fn index(self) -> u64

TODO(doc): @quake

pub fn length(self) -> u64

TODO(doc): @quake

pub const fn full_value(self) -> u64

TODO(doc): @quake

pub fn minimum_epoch_number_after_n_blocks(self, n: BlockNumber) -> EpochNumber

Estimate the floor limit of epoch number after N blocks.

Since we couldn’t know the length of next epoch before reach the next epoch, this function could only return self.number() or self.number()+1.

pub fn from_full_value(value: u64) -> Self

TODO(doc): @quake

pub fn from_full_value_unchecked(value: u64) -> Self

Converts from an unsigned 64 bits number without checks.

Notice

The EpochNumberWithFraction constructed by this method has a potential risk that when call self.to_rational() may lead to a panic if the user specifies a zero epoch length.

pub fn normalize(self) -> Self

Prevents leading to a panic if the EpochNumberWithFraction is constructed without checks.

pub fn to_rational(self) -> RationalU256

Converts the epoch to an unsigned 256 bits rational.

Panics

Only genesis epoch’s length could be zero, otherwise causes a division-by-zero panic.

pub fn is_successor_of(self, predecessor: Self) -> bool

Check if current value is another value’s successor.

pub fn is_well_formed(self) -> bool

Check the data format.

The epoch length should be greater than zero. The epoch index should be less than the epoch length.

pub fn is_well_formed_increment(self) -> bool

Check the data format as an increment.

The epoch index should be less than the epoch length or both of them are zero.

Trait Implementations

impl Clone for EpochNumberWithFraction

fn clone(&self) -> EpochNumberWithFraction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EpochNumberWithFraction

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

Formats the value using the given formatter.

impl Display for EpochNumberWithFraction

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

Formats the value using the given formatter.

impl FromStr for EpochNumberWithFraction

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for EpochNumberWithFraction

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for EpochNumberWithFraction

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl Pack<Uint64> for EpochNumberWithFraction

fn pack(&self) -> Uint64

Packs a rust type into binary data.

impl PartialEq<EpochNumberWithFraction> for EpochNumberWithFraction

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<EpochNumberWithFraction> for EpochNumberWithFraction

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Unpack<EpochNumberWithFraction> for Uint64

fn unpack(&self) -> EpochNumberWithFraction

Unpack binary data into rust types.

impl<'r> Unpack<EpochNumberWithFraction> for Uint64Reader<'r>

fn unpack(&self) -> EpochNumberWithFraction

Unpack binary data into rust types.

impl Copy for EpochNumberWithFraction

impl Eq for EpochNumberWithFraction

impl StructuralEq for EpochNumberWithFraction

impl StructuralPartialEq for EpochNumberWithFraction