Struct secret_cosmwasm_std::Event

#[non_exhaustive]
pub struct Event {
    pub ty: String,
    pub attributes: Vec<Attribute>,
}

A full Cosmos SDK event.

This version uses string attributes (similar to Cosmos SDK StringEvent), which then get magically converted to bytes for Tendermint somewhere between the Rust-Go interface, JSON deserialization and the NewEvent call in Cosmos SDK.

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.

ty: String

The event type. This is renamed to “ty” because “type” is reserved in Rust. This sucks, we know.

attributes: Vec<Attribute>

The attributes to be included in the event.

You can learn more about these from Cosmos SDK docs.

Implementations

impl Event

pub fn new(ty: impl Into<String>) -> Self

Create a new event with the given type and an empty list of attributes.

pub fn add_attribute(
    self,
    key: impl Into<String>,
    value: impl Into<String>
) -> Self

Add an ENCRYPTED attribute to the event. Only the transaction sender can decrypt it.

pub fn add_attribute_plaintext(
    self,
    key: impl Into<String>,
    value: impl Into<String>
) -> Self

Add a NON-ENCRYPTED attribute to the event. This key-value pair will be a public on-chain output for the transaction. This is a good way of indexing public contract data on-chain.

pub fn add_attributes<A: Into<Attribute>>(
    self,
    attrs: impl IntoIterator<Item = A>
) -> Self

Bulk add attributes to the event.

Anything that can be turned into an iterator and yields something that can be converted into an Attribute is accepted.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

const 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<'de> Deserialize<'de> for Event

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

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Event

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

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 ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Event

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 Event