Struct tendermint::block::Id

pub struct Id {
    pub hash: Hash,
    pub part_set_header: PartSetHeader,
}

Block identifiers which contain two distinct Merkle roots of the block, as well as the number of parts in the block.

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

Default implementation is an empty Id as defined by the Go implementation in https://github.com/tendermint/tendermint/blob/1635d1339c73ae6a82e062cd2dc7191b029efa14/types/block.go#L1204.

If the Hash is empty in BlockId, the BlockId should be empty (encoded to None). This is implemented outside of this struct. Use the Default trait to check for an empty BlockId. See: https://github.com/informalsystems/tendermint-rs/issues/663

Fields

hash: Hash

The block’s main hash is the Merkle root of all the fields in the block header.

part_set_header: PartSetHeader

Parts header (if available) is used for secure gossipping of the block during consensus. It is the Merkle root of the complete serialized block cut into parts.

PartSet is used to split a byteslice of data into parts (pieces) for transmission. By splitting data into smaller parts and computing a Merkle root hash on the list, you can verify that a part is legitimately part of the complete data, and the part can be forwarded to other peers before all the parts are known. In short, it’s a fast way to propagate a large file over a gossip network.

https://github.com/tendermint/tendermint/wiki/Block-Structure#partset

PartSetHeader in protobuf is defined as never nil using the gogoproto annotations. This does not translate to Rust, but we can indicate this in the domain type.

Implementations

impl Id

pub fn prefix(&self) -> String

Get a shortened 12-character prefix of a block ID (ala git)

Trait Implementations

impl Clone for Id

fn clone(&self) -> Id

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Id

impl Debug for Id

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

Formats the value using the given formatter.

impl Default for Id

fn default() -> Id

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Id

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

Deserialize this value from the given Serde deserializer.

impl Display for Id

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

Formats the value using the given formatter.

impl Eq for Id

impl FromStr for Id

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.

impl Hash for Id

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Id

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Id> for Id

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

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

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

This method tests for !=.

impl PartialOrd<Id> for Id

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl Protobuf<BlockId> for Id

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 Id

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Id

impl StructuralPartialEq for Id

impl TryFrom<BlockId> for Id

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<CanonicalBlockId> for Id

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.