Struct EpochInfo 

pub struct EpochInfo {
    pub name: String,
    pub next_tick: u32,
    pub duration: u32,
    pub current_epoch: u32,
    pub current_epoch_start_block: u32,
    pub is_initialized: bool,
    pub fast_forward_next_tick: bool,
}

EpochInfo stores metadata of an epoch timer.

Fields

name: String

name is the unique identifier.

next_tick: u32

next_tick indicates when the next epoch starts (in Unix Epoch seconds), if EpochInfo has been initialized. If EpochInfo is not initialized yet, next_tick indicates the earliest initialization time (see is_initialized below).

duration: u32

duration of the epoch in seconds.

current_epoch: u32

current epoch is the number of the current epoch. 0 if next_tick has never been reached, positive otherwise.

current_epoch_start_block: u32

current_epoch_start_block indicates the block height when the current epoch started. 0 if current_epoch is 0.

is_initialized: bool

is_initialized indicates whether the EpochInfo has been initialized and started ticking. An EpochInfo is initialized when all below conditions are true:

• Not yet initialized
• BlockHeight >= 2
• BlockTime >= next_tick

fast_forward_next_tick: bool

fast_forward_next_tick specifies whether during initialization, next_tick should be fast-forwarded to be greater than the current block time. If false, the original next_tick value is unchanged during initialization. If true, next_tick will be set to the smallest value x greater than the current block time such that (x - next_tick) % duration = 0.

Trait Implementations

impl Clone for EpochInfo

fn clone(&self) -> EpochInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EpochInfo

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

Formats the value using the given formatter.

impl Default for EpochInfo

fn default() -> EpochInfo

Returns the “default value” for a type.

impl Message for EpochInfo

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for EpochInfo

const NAME: &'static str = "EpochInfo"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "dydxprotocol.epochs"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for EpochInfo

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