Struct ConsensusCommitPrologue

#[non_exhaustive]
pub struct ConsensusCommitPrologue {
    pub epoch: Option<u64>,
    pub round: Option<u64>,
    pub commit_timestamp: Option<Timestamp>,
    pub consensus_commit_digest: Option<String>,
    pub sub_dag_index: Option<u64>,
    pub consensus_determined_version_assignments: Option<ConsensusDeterminedVersionAssignments>,
    pub additional_state_digest: Option<String>,
}

Consensus commit prologue system transaction.

This message can represent V1, V2, and V3 prologue types.

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>

Epoch of the commit prologue transaction.

Present in V1, V2, V3, V4.

round: Option<u64>

Consensus round of the commit.

Present in V1, V2, V3, V4.

commit_timestamp: Option<Timestamp>

Unix timestamp from consensus.

Present in V1, V2, V3, V4.

consensus_commit_digest: Option<String>

Digest of consensus output.

Present in V2, V3, V4.

sub_dag_index: Option<u64>

The sub DAG index of the consensus commit. This field is populated if there are multiple consensus commits per round.

Present in V3, V4.

consensus_determined_version_assignments: Option<ConsensusDeterminedVersionAssignments>

Stores consensus handler determined consensus object version assignments.

Present in V3, V4.

additional_state_digest: Option<String>

Digest of any additional state computed by the consensus handler. Used to detect forking bugs as early as possible.

Present in V4.

Implementations

impl ConsensusCommitPrologue

pub const EPOCH_FIELD: &'static MessageField

pub const ROUND_FIELD: &'static MessageField

pub const COMMIT_TIMESTAMP_FIELD: &'static MessageField

pub const CONSENSUS_COMMIT_DIGEST_FIELD: &'static MessageField

pub const SUB_DAG_INDEX_FIELD: &'static MessageField

pub const CONSENSUS_DETERMINED_VERSION_ASSIGNMENTS_FIELD: &'static MessageField

pub const ADDITIONAL_STATE_DIGEST_FIELD: &'static MessageField

impl ConsensusCommitPrologue

pub fn path_builder() -> ConsensusCommitPrologueFieldPathBuilder

impl ConsensusCommitPrologue

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

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

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

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

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

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

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

Sets round with the provided value.

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

Sets round with the provided value.

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

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

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

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

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

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

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

Sets commit_timestamp with the provided value.

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

Sets commit_timestamp with the provided value.

pub fn consensus_commit_digest_opt_mut(&mut self) -> Option<&mut String>

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

pub fn consensus_commit_digest_mut(&mut self) -> &mut String

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

pub fn consensus_commit_digest_opt(&self) -> Option<&str>

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

pub fn set_consensus_commit_digest<T: Into<String>>(&mut self, field: T)

Sets consensus_commit_digest with the provided value.

pub fn with_consensus_commit_digest<T: Into<String>>(self, field: T) -> Self

Sets consensus_commit_digest with the provided value.

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

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

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

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

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

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

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

Sets sub_dag_index with the provided value.

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

Sets sub_dag_index with the provided value.

pub fn consensus_determined_version_assignments( &self, ) -> &ConsensusDeterminedVersionAssignments

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

pub fn consensus_determined_version_assignments_opt_mut( &mut self, ) -> Option<&mut ConsensusDeterminedVersionAssignments>

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

pub fn consensus_determined_version_assignments_mut( &mut self, ) -> &mut ConsensusDeterminedVersionAssignments

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

pub fn consensus_determined_version_assignments_opt( &self, ) -> Option<&ConsensusDeterminedVersionAssignments>

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

pub fn set_consensus_determined_version_assignments<T: Into<ConsensusDeterminedVersionAssignments>>( &mut self, field: T, )

Sets consensus_determined_version_assignments with the provided value.

pub fn with_consensus_determined_version_assignments<T: Into<ConsensusDeterminedVersionAssignments>>( self, field: T, ) -> Self

Sets consensus_determined_version_assignments with the provided value.

pub fn additional_state_digest_opt_mut(&mut self) -> Option<&mut String>

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

pub fn additional_state_digest_mut(&mut self) -> &mut String

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

pub fn additional_state_digest_opt(&self) -> Option<&str>

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

pub fn set_additional_state_digest<T: Into<String>>(&mut self, field: T)

Sets additional_state_digest with the provided value.

pub fn with_additional_state_digest<T: Into<String>>(self, field: T) -> Self

Sets additional_state_digest with the provided value.

impl ConsensusCommitPrologue

pub fn epoch(&self) -> u64

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

pub fn round(&self) -> u64

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

pub fn consensus_commit_digest(&self) -> &str

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

pub fn sub_dag_index(&self) -> u64

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

pub fn additional_state_digest(&self) -> &str

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

Trait Implementations

impl Clone for ConsensusCommitPrologue

fn clone(&self) -> ConsensusCommitPrologue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConsensusCommitPrologue

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

Formats the value using the given formatter.

impl Default for ConsensusCommitPrologue

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConsensusCommitPrologue

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ConsensusCommitPrologue> for ConsensusCommitPrologue

fn from(value: ConsensusCommitPrologue) -> Self

Converts to this type from the input type.

impl From<ConsensusCommitPrologueV2> for ConsensusCommitPrologue

fn from(value: ConsensusCommitPrologueV2) -> Self

Converts to this type from the input type.

impl From<ConsensusCommitPrologueV3> for ConsensusCommitPrologue

fn from(value: ConsensusCommitPrologueV3) -> Self

Converts to this type from the input type.

impl From<ConsensusCommitPrologueV4> for ConsensusCommitPrologue

fn from(_: ConsensusCommitPrologueV4) -> Self

Converts to this type from the input type.

impl Message for ConsensusCommitPrologue

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 ConsensusCommitPrologue

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

impl PartialEq for ConsensusCommitPrologue

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&ConsensusCommitPrologue> for ConsensusCommitPrologue

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(value: &ConsensusCommitPrologue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ConsensusCommitPrologue> for ConsensusCommitPrologueV2

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(value: &ConsensusCommitPrologue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ConsensusCommitPrologue> for ConsensusCommitPrologueV3

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(value: &ConsensusCommitPrologue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ConsensusCommitPrologue> for ConsensusCommitPrologueV4

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(value: &ConsensusCommitPrologue) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for ConsensusCommitPrologue