Struct tendermint::abci::Event

pub struct Event {
    pub kind: String,
    pub attributes: Vec<EventAttribute>,
}

An event that occurred while processing a request.

Application developers can attach additional information to BeginBlock, EndBlock, CheckTx, and DeliverTx responses. Later, transactions may be queried using these events.

ABCI documentation

Fields

kind: String

The kind of event.

Tendermint calls this the type, but we use kind to avoid confusion with Rust types and follow Rust conventions.

attributes: Vec<EventAttribute>

A list of EventAttributes describing the event.

Implementations

impl Event

pub fn new<K, I>(kind: K, attributes: I) -> Self where
    K: Into<String>,
    I: IntoIterator,
    I::Item: Into<EventAttribute>, 

Construct an event from generic data.

The From impls on EventAttribute and the EventAttributeIndexExt trait allow ergonomic event construction, as in this example:

use tendermint::abci::{Event, EventAttributeIndexExt};

let event = Event::new(
    "app",
    vec![
        ("key1", "value1").index(),
        ("key2", "value2").index(),
        ("key3", "value3").no_index(), // will not be indexed
    ],
);

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl From<Event> for Event

fn from(event: Event) -> Self

Performs the conversion.

impl PartialEq<Event> for Event

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

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

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

This method tests for !=.

impl Protobuf<Event> for Event

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

Encode into a buffer in Protobuf format.

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

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

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

Constructor that attempts to decode an instance from a buffer.

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

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

fn encoded_len(&self) -> usize

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

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

Encodes into a Protobuf-encoded Vec<u8>.

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

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

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

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

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

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

impl TryFrom<Event> for Event

type Error = Error

The type returned in the event of a conversion error.

fn try_from(event: Event) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Event

impl StructuralEq for Event

impl StructuralPartialEq for Event