Struct Precommit

#[non_exhaustive]
pub struct Precommit {
    pub validator: ValidatorId,
    pub epoch: Height,
    pub round: Round,
    pub propose_hash: Hash,
    pub block_hash: Hash,
    pub time: DateTime<Utc>,
}

Pre-commit for a block, essentially meaning that a validator node endorses the block. The consensus algorithm ensures that once a Byzantine majority of validators has endorsed a block, no other block at the same height may be endorsed at any point in the future. Thus, such a block can be considered committed.

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.

validator: ValidatorId

ID of the validator endorsing the block.

epoch: Height

The height to which the message is related.

round: Round

The round to which the message is related.

propose_hash: Hash

Hash of the block proposal. Note that the proposal format is not defined by the core.

block_hash: Hash

Hash of the new block.

time: DateTime<Utc>

Local time of the validator node when the Precommit was created.

Implementations

impl Precommit

pub fn new( validator: ValidatorId, epoch: Height, round: Round, propose_hash: Hash, block_hash: Hash, time: DateTime<Utc>, ) -> Self

Create new Precommit message.

Trait Implementations

impl Clone for Precommit

fn clone(&self) -> Precommit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Precommit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Precommit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Precommit> for CoreMessage

fn from(precommit: Precommit) -> Self

Converts to this type from the input type.

impl IntoMessage for Precommit

type Container = CoreMessage

Container for the message.

impl Ord for Precommit

fn cmp(&self, other: &Precommit) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Precommit

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

fn partial_cmp(&self, other: &Precommit) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ProtobufConvert for Precommit

type ProtoStruct = Precommit

Type generated from the Protobuf definition.

fn from_pb(pb: Self::ProtoStruct) -> Result<Self, Error>

Performs conversion from the type generated from Protobuf.

fn to_pb(&self) -> Self::ProtoStruct

Performs conversion to the type generated from Protobuf.

impl Serialize for Precommit

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&SignedMessage> for Precommit

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<CoreMessage> for Precommit

type Error = Error

The type returned in the event of a conversion error.

fn try_from(msg: CoreMessage) -> Result<Self>

Performs the conversion.

impl TryFrom<SignedMessage> for Precommit

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Precommit

impl StructuralPartialEq for Precommit