Struct tendermint::vote::Vote

pub struct Vote {
    pub vote_type: Type,
    pub height: Height,
    pub round: Round,
    pub block_id: Option<Id>,
    pub timestamp: Option<Time>,
    pub validator_address: Id,
    pub validator_index: ValidatorIndex,
    pub signature: Signature,
}

Votes are signed messages from validators for a particular block which include information about the validator signing it.

https://github.com/tendermint/spec/blob/d46cd7f573a2c6a2399fcab2cde981330aa63f37/spec/core/data_structures.md#vote

Fields

vote_type: Type

Type of vote (prevote or precommit)

height: Height

Block height

round: Round

Round

block_id: Option<Id>

Block ID

timestamp: Option<Time>

Timestamp

validator_address: Id

Validator address

validator_index: ValidatorIndex

Validator index

signature: Signature

Signature

Implementations

impl Vote

pub fn is_prevote(&self) -> bool

Is this vote a prevote?

pub fn is_precommit(&self) -> bool

Is this vote a precommit?

pub fn header_hash(&self) -> Option<Hash>

Returns block_id.hash

pub fn to_signable_bytes<B>(
    &self,
    chain_id: ChainId,
    sign_bytes: &mut B
) -> Result<bool, ProtobufError> where
    B: BufMut, 

Create signable bytes from Vote.

pub fn to_signable_vec(
    &self,
    chain_id: ChainId
) -> Result<Vec<u8>, ProtobufError>

Create signable vector from Vote.

pub fn consensus_state(&self) -> State

👎 Deprecated since 0.17.0:

This seems unnecessary, please raise it to the team, if you need it.

Consensus state from this vote - This doesn’t seem to be used anywhere.

Trait Implementations

impl Clone for Vote

fn clone(&self) -> Vote

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vote

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

Formats the value using the given formatter.

impl Default for Vote

Default trait. Used in tests.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Vote

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Vote> for Vote

fn eq(&self, other: &Vote) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Vote) -> bool

This method tests for !=.

impl Protobuf<Vote> for Vote

pub fn encode<B>(&self, buf: &mut B) -> Result<(), Error<Kind>> where
    B: BufMut, 

Encode into a buffer in Protobuf format.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), Error<Kind>> where
    B: BufMut, 

Encode with a length-delimiter to a buffer in Protobuf format.

pub fn decode<B>(buf: B) -> Result<Self, Error<Kind>> where
    B: Buf, 

Constructor that attempts to decode an instance from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, Error<Kind>> where
    B: Buf, 

Constructor that attempts to decode a length-delimited instance from the buffer.

pub fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

pub fn encode_vec(&self) -> Result<Vec<u8, Global>, Error<Kind>>

Encodes into a Protobuf-encoded Vec<u8>.

pub fn decode_vec(v: &[u8]) -> Result<Self, Error<Kind>>

Constructor that attempts to decode a Protobuf-encoded instance from a Vec<u8> (or equivalent).

pub fn encode_length_delimited_vec(
    &self
) -> Result<Vec<u8, Global>, Error<Kind>>

Encode with a length-delimiter to a Vec<u8> Protobuf-encoded message.

pub fn decode_length_delimited_vec(v: &[u8]) -> Result<Self, Error<Kind>>

Constructor that attempts to decode a Protobuf-encoded instance with a length-delimiter from a Vec<u8> or equivalent.

impl Serialize for Vote

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Vote

impl TryFrom<Vote> for Vote

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.