Struct Event 

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

The Event serialization in the latest RPC dialect is the canonical serialization for the ABCI domain type. 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.

CometBFT 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) -> Event

where K: Into<String>, I: IntoIterator, <I as IntoIterator>::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 cometbft::abci::{Event, EventAttributeIndexExt};

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

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

Checks whether &self is equal to other, ignoring the index field on any attributes.

pub fn hash_ignoring_index<H>(&self, state: &mut H)

where H: Hasher,

A variant of core::hash::Hash::hash that ignores the index field on any attributes.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Event> for Event

fn from(event: Event) -> Event

Converts to this type from the input type.

impl From<Event> for Event

fn from(event: Event) -> Event

Converts to this type from the input type.

impl From<Event> for Event

fn from(event: Event) -> Event

Converts to this type from the input type.

impl From<Event> for Event

fn from(msg: Event) -> Self

Converts to this type from the input type.

impl From<Event> for Event

fn from(msg: Event) -> Self

Converts to this type from the input type.

impl Hash for Event

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Event

fn eq(&self, other: &Event) -> 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 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) -> Vec<u8>

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) -> Vec<u8>

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 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) -> Vec<u8>

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) -> Vec<u8>

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 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) -> Vec<u8>

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) -> Vec<u8>

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 Serialize for Event

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Event> for Event

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Event> for Event

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Event> for Event

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Event

impl StructuralPartialEq for Event