Struct Epoch

#[non_exhaustive]
pub struct Epoch {
    pub epoch: Option<u64>,
    pub committee: Option<ValidatorCommittee>,
    pub system_state: Option<Box<SystemState>>,
    pub first_checkpoint: Option<u64>,
    pub last_checkpoint: Option<u64>,
    pub start: Option<Timestamp>,
    pub end: Option<Timestamp>,
    pub reference_gas_price: Option<u64>,
    pub protocol_config: Option<ProtocolConfig>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

epoch: Option<u64>

committee: Option<ValidatorCommittee>

The committee governing this epoch.

system_state: Option<Box<SystemState>>

Snapshot of Sui’s SystemState (0x3::sui_system::SystemState) at the beginning of the epoch, for past epochs, or the current state for the current epoch.

first_checkpoint: Option<u64>

last_checkpoint: Option<u64>

start: Option<Timestamp>

end: Option<Timestamp>

reference_gas_price: Option<u64>

Reference gas price denominated in MIST

protocol_config: Option<ProtocolConfig>

Implementations

impl Epoch

pub const EPOCH_FIELD: &'static MessageField

pub const COMMITTEE_FIELD: &'static MessageField

pub const SYSTEM_STATE_FIELD: &'static MessageField

pub const FIRST_CHECKPOINT_FIELD: &'static MessageField

pub const LAST_CHECKPOINT_FIELD: &'static MessageField

pub const START_FIELD: &'static MessageField

pub const END_FIELD: &'static MessageField

pub const REFERENCE_GAS_PRICE_FIELD: &'static MessageField

pub const PROTOCOL_CONFIG_FIELD: &'static MessageField

impl Epoch

pub fn path_builder() -> EpochFieldPathBuilder

impl Epoch

pub const fn const_default() -> Self

pub fn epoch_opt_mut(&mut self) -> Option<&mut u64>

If epoch is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn epoch_mut(&mut self) -> &mut u64

Returns a mutable reference to epoch. If the field is unset, it is first initialized with the default value.

pub fn epoch_opt(&self) -> Option<u64>

If epoch is set, returns Some with the value; otherwise returns None.

pub fn set_epoch<T: Into<u64>>(&mut self, field: T)

Sets epoch with the provided value.

pub fn with_epoch<T: Into<u64>>(self, field: T) -> Self

Sets epoch with the provided value.

pub fn committee(&self) -> &ValidatorCommittee

Returns the value of committee, or the default value if committee is unset.

pub fn committee_opt_mut(&mut self) -> Option<&mut ValidatorCommittee>

If committee is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn committee_mut(&mut self) -> &mut ValidatorCommittee

Returns a mutable reference to committee. If the field is unset, it is first initialized with the default value.

pub fn committee_opt(&self) -> Option<&ValidatorCommittee>

If committee is set, returns Some with the value; otherwise returns None.

pub fn set_committee<T: Into<ValidatorCommittee>>(&mut self, field: T)

Sets committee with the provided value.

pub fn with_committee<T: Into<ValidatorCommittee>>(self, field: T) -> Self

Sets committee with the provided value.

pub fn system_state(&self) -> &SystemState

Returns the value of system_state, or the default value if system_state is unset.

pub fn system_state_opt_mut(&mut self) -> Option<&mut SystemState>

If system_state is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn system_state_mut(&mut self) -> &mut SystemState

Returns a mutable reference to system_state. If the field is unset, it is first initialized with the default value.

pub fn system_state_opt(&self) -> Option<&SystemState>

If system_state is set, returns Some with the value; otherwise returns None.

pub fn set_system_state<T: Into<SystemState>>(&mut self, field: T)

Sets system_state with the provided value.

pub fn with_system_state<T: Into<SystemState>>(self, field: T) -> Self

Sets system_state with the provided value.

pub fn first_checkpoint_opt_mut(&mut self) -> Option<&mut u64>

If first_checkpoint is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn first_checkpoint_mut(&mut self) -> &mut u64

Returns a mutable reference to first_checkpoint. If the field is unset, it is first initialized with the default value.

pub fn first_checkpoint_opt(&self) -> Option<u64>

If first_checkpoint is set, returns Some with the value; otherwise returns None.

pub fn set_first_checkpoint<T: Into<u64>>(&mut self, field: T)

Sets first_checkpoint with the provided value.

pub fn with_first_checkpoint<T: Into<u64>>(self, field: T) -> Self

Sets first_checkpoint with the provided value.

pub fn last_checkpoint_opt_mut(&mut self) -> Option<&mut u64>

If last_checkpoint is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn last_checkpoint_mut(&mut self) -> &mut u64

Returns a mutable reference to last_checkpoint. If the field is unset, it is first initialized with the default value.

pub fn last_checkpoint_opt(&self) -> Option<u64>

If last_checkpoint is set, returns Some with the value; otherwise returns None.

pub fn set_last_checkpoint<T: Into<u64>>(&mut self, field: T)

Sets last_checkpoint with the provided value.

pub fn with_last_checkpoint<T: Into<u64>>(self, field: T) -> Self

Sets last_checkpoint with the provided value.

pub fn start_opt_mut(&mut self) -> Option<&mut Timestamp>

If start is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn start_mut(&mut self) -> &mut Timestamp

Returns a mutable reference to start. If the field is unset, it is first initialized with the default value.

pub fn start_opt(&self) -> Option<&Timestamp>

If start is set, returns Some with the value; otherwise returns None.

pub fn set_start<T: Into<Timestamp>>(&mut self, field: T)

Sets start with the provided value.

pub fn with_start<T: Into<Timestamp>>(self, field: T) -> Self

Sets start with the provided value.

pub fn end_opt_mut(&mut self) -> Option<&mut Timestamp>

If end is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn end_mut(&mut self) -> &mut Timestamp

Returns a mutable reference to end. If the field is unset, it is first initialized with the default value.

pub fn end_opt(&self) -> Option<&Timestamp>

If end is set, returns Some with the value; otherwise returns None.

pub fn set_end<T: Into<Timestamp>>(&mut self, field: T)

Sets end with the provided value.

pub fn with_end<T: Into<Timestamp>>(self, field: T) -> Self

Sets end with the provided value.

pub fn reference_gas_price_opt_mut(&mut self) -> Option<&mut u64>

If reference_gas_price is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn reference_gas_price_mut(&mut self) -> &mut u64

Returns a mutable reference to reference_gas_price. If the field is unset, it is first initialized with the default value.

pub fn reference_gas_price_opt(&self) -> Option<u64>

If reference_gas_price is set, returns Some with the value; otherwise returns None.

pub fn set_reference_gas_price<T: Into<u64>>(&mut self, field: T)

Sets reference_gas_price with the provided value.

pub fn with_reference_gas_price<T: Into<u64>>(self, field: T) -> Self

Sets reference_gas_price with the provided value.

pub fn protocol_config(&self) -> &ProtocolConfig

Returns the value of protocol_config, or the default value if protocol_config is unset.

pub fn protocol_config_opt_mut(&mut self) -> Option<&mut ProtocolConfig>

If protocol_config is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn protocol_config_mut(&mut self) -> &mut ProtocolConfig

Returns a mutable reference to protocol_config. If the field is unset, it is first initialized with the default value.

pub fn protocol_config_opt(&self) -> Option<&ProtocolConfig>

If protocol_config is set, returns Some with the value; otherwise returns None.

pub fn set_protocol_config<T: Into<ProtocolConfig>>(&mut self, field: T)

Sets protocol_config with the provided value.

pub fn with_protocol_config<T: Into<ProtocolConfig>>(self, field: T) -> Self

Sets protocol_config with the provided value.

impl Epoch

pub fn epoch(&self) -> u64

Returns the value of epoch, or the default value if epoch is unset.

pub fn first_checkpoint(&self) -> u64

Returns the value of first_checkpoint, or the default value if first_checkpoint is unset.

pub fn last_checkpoint(&self) -> u64

Returns the value of last_checkpoint, or the default value if last_checkpoint is unset.

pub fn reference_gas_price(&self) -> u64

Returns the value of reference_gas_price, or the default value if reference_gas_price is unset.

Trait Implementations

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

Formats the value using the given formatter.

impl Default for Epoch

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Merge<&Epoch> for Epoch

fn merge(&mut self, source: &Epoch, mask: &FieldMaskTree)

fn merge_from(source: T, mask: &FieldMaskTree) -> Self

where Self: Default,

impl Message for Epoch

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

const FIELDS: &'static [&'static MessageField]

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Epoch