Struct EndOfEpochData

#[non_exhaustive]
pub struct EndOfEpochData {
    pub next_epoch_committee: Vec<ValidatorCommitteeMember>,
    pub next_epoch_protocol_version: Option<u64>,
    pub epoch_commitments: Vec<CheckpointCommitment>,
}

Data, which when included in a CheckpointSummary, signals the end of an 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.

next_epoch_committee: Vec<ValidatorCommitteeMember>

The set of validators that will be in the ValidatorCommittee for the next epoch.

next_epoch_protocol_version: Option<u64>

The protocol version that is in effect during the next epoch.

epoch_commitments: Vec<CheckpointCommitment>

Commitments to epoch specific state (live object set)

Implementations

impl EndOfEpochData

pub const NEXT_EPOCH_COMMITTEE_FIELD: &'static MessageField

pub const NEXT_EPOCH_PROTOCOL_VERSION_FIELD: &'static MessageField

pub const EPOCH_COMMITMENTS_FIELD: &'static MessageField

impl EndOfEpochData

pub fn path_builder() -> EndOfEpochDataFieldPathBuilder

impl EndOfEpochData

pub const fn const_default() -> Self

pub fn next_epoch_committee(&self) -> &[ValidatorCommitteeMember]

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

pub fn next_epoch_committee_mut(&mut self) -> &mut Vec<ValidatorCommitteeMember>

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

pub fn set_next_epoch_committee(&mut self, field: Vec<ValidatorCommitteeMember>)

Sets next_epoch_committee with the provided value.

pub fn with_next_epoch_committee( self, field: Vec<ValidatorCommitteeMember>, ) -> Self

Sets next_epoch_committee with the provided value.

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

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

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

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

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

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

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

Sets next_epoch_protocol_version with the provided value.

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

Sets next_epoch_protocol_version with the provided value.

pub fn epoch_commitments(&self) -> &[CheckpointCommitment]

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

pub fn epoch_commitments_mut(&mut self) -> &mut Vec<CheckpointCommitment>

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

pub fn set_epoch_commitments(&mut self, field: Vec<CheckpointCommitment>)

Sets epoch_commitments with the provided value.

pub fn with_epoch_commitments(self, field: Vec<CheckpointCommitment>) -> Self

Sets epoch_commitments with the provided value.

impl EndOfEpochData

pub fn next_epoch_protocol_version(&self) -> u64

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

Trait Implementations

impl Clone for EndOfEpochData

fn clone(&self) -> EndOfEpochData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EndOfEpochData

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

Formats the value using the given formatter.

impl Default for EndOfEpochData

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EndOfEpochData

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<EndOfEpochData> for EndOfEpochData

fn from(_: EndOfEpochData) -> Self

Converts to this type from the input type.

impl Message for EndOfEpochData

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 EndOfEpochData

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

impl PartialEq for EndOfEpochData

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&EndOfEpochData> for EndOfEpochData

type Error = TryFromProtoError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for EndOfEpochData