Struct ChangeEpoch

#[non_exhaustive]
pub struct ChangeEpoch {
    pub epoch: Option<u64>,
    pub protocol_version: Option<u64>,
    pub storage_charge: Option<u64>,
    pub computation_charge: Option<u64>,
    pub storage_rebate: Option<u64>,
    pub non_refundable_storage_fee: Option<u64>,
    pub epoch_start_timestamp: Option<Timestamp>,
    pub system_packages: Vec<SystemPackage>,
}

System transaction used to change the epoch.

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>

The next (to become) epoch ID.

protocol_version: Option<u64>

The protocol version in effect in the new epoch.

storage_charge: Option<u64>

The total amount of gas charged for storage during the epoch.

computation_charge: Option<u64>

The total amount of gas charged for computation during the epoch.

storage_rebate: Option<u64>

The amount of storage rebate refunded to the txn senders.

non_refundable_storage_fee: Option<u64>

The non-refundable storage fee.

epoch_start_timestamp: Option<Timestamp>

Unix timestamp when epoch started.

system_packages: Vec<SystemPackage>

System packages (specifically framework and Move stdlib) that are written before the new epoch starts. This tracks framework upgrades on chain. When executing the ChangeEpoch txn, the validator must write out the following modules. Modules are provided with the version they will be upgraded to, their modules in serialized form (which include their package ID), and a list of their transitive dependencies.

Implementations

impl ChangeEpoch

pub const EPOCH_FIELD: &'static MessageField

pub const PROTOCOL_VERSION_FIELD: &'static MessageField

pub const STORAGE_CHARGE_FIELD: &'static MessageField

pub const COMPUTATION_CHARGE_FIELD: &'static MessageField

pub const STORAGE_REBATE_FIELD: &'static MessageField

pub const NON_REFUNDABLE_STORAGE_FEE_FIELD: &'static MessageField

pub const EPOCH_START_TIMESTAMP_FIELD: &'static MessageField

pub const SYSTEM_PACKAGES_FIELD: &'static MessageField

impl ChangeEpoch

pub fn path_builder() -> ChangeEpochFieldPathBuilder

impl ChangeEpoch

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 protocol_version_opt_mut(&mut self) -> Option<&mut u64>

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

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

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

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

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

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

Sets protocol_version with the provided value.

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

Sets protocol_version with the provided value.

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

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

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

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

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

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

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

Sets storage_charge with the provided value.

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

Sets storage_charge with the provided value.

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

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

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

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

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

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

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

Sets computation_charge with the provided value.

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

Sets computation_charge with the provided value.

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

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

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

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

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

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

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

Sets storage_rebate with the provided value.

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

Sets storage_rebate with the provided value.

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

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

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

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

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

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

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

Sets non_refundable_storage_fee with the provided value.

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

Sets non_refundable_storage_fee with the provided value.

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

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

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

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

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

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

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

Sets epoch_start_timestamp with the provided value.

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

Sets epoch_start_timestamp with the provided value.

pub fn system_packages(&self) -> &[SystemPackage]

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

pub fn system_packages_mut(&mut self) -> &mut Vec<SystemPackage>

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

pub fn set_system_packages(&mut self, field: Vec<SystemPackage>)

Sets system_packages with the provided value.

pub fn with_system_packages(self, field: Vec<SystemPackage>) -> Self

Sets system_packages with the provided value.

impl ChangeEpoch

pub fn epoch(&self) -> u64

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

pub fn protocol_version(&self) -> u64

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

pub fn storage_charge(&self) -> u64

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

pub fn computation_charge(&self) -> u64

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

pub fn storage_rebate(&self) -> u64

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

pub fn non_refundable_storage_fee(&self) -> u64

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

Trait Implementations

impl Clone for ChangeEpoch

fn clone(&self) -> ChangeEpoch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChangeEpoch

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

Formats the value using the given formatter.

impl Default for ChangeEpoch

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChangeEpoch

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ChangeEpoch> for ChangeEpoch

fn from(value: ChangeEpoch) -> Self

Converts to this type from the input type.

impl Message for ChangeEpoch

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 ChangeEpoch

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

impl PartialEq for ChangeEpoch

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&ChangeEpoch> for ChangeEpoch

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(_: &ChangeEpoch) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for ChangeEpoch