Struct ConsensusCommitPrologue

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

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 shared 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 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 copy 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 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 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 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