Struct EventMetadata 

pub struct EventMetadata {
    pub description: String,
    pub on_trigger: String,
    pub on_publish: String,
}

Metadata for an event topic.

Defines what an event means, enabling auto-derived instructions for hats. When a hat triggers on or publishes an event, this metadata is used to generate appropriate behavior instructions.

Example:

events:
  deploy.start:
    description: "Deployment has been requested"
    on_trigger: "Prepare artifacts, validate config, check dependencies"
    on_publish: "Signal that deployment should begin"

Fields

description: String

Brief description of what this event represents.

on_trigger: String

Instructions for a hat that triggers on (receives) this event. Describes what the hat should do when it receives this event.

on_publish: String

Instructions for a hat that publishes (emits) this event. Describes when/how the hat should emit this event.

Trait Implementations

impl Clone for EventMetadata

fn clone(&self) -> EventMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventMetadata

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

Formats the value using the given formatter.

impl Default for EventMetadata

fn default() -> EventMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EventMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EventMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.