Struct EventKind 

pub struct EventKind { /* private fields */ }

Domain-neutral event identity and structured fields.

The type tag and flattened field layout deliberately preserve the wire shape used by earlier concrete event variants. Domain crates and runtime compatibility modules own typed payloads and encode them through Self::from_payload; this crate does not own their vocabulary.

Implementations

impl EventKind

pub fn from_fields( event_type: impl Into<String>, fields: BTreeMap<String, Value>, ) -> Result<EventKind, EventKindError>

Builds an event record from an explicit type and flattened fields.

Errors

Returns an error when the type is empty or the fields contain the reserved type key.

pub fn from_payload<T>( event_type: impl Into<String>, payload: &T, ) -> Result<EventKind, EventKindError>

where T: Serialize,

Serializes a typed domain payload into an event record.

Errors

Returns an error when serialization fails, the payload is not an object, the type is empty, or the payload contains the reserved type key.

pub fn plugin( plugin: impl Into<String>, event_type: impl Into<String>, ) -> EventKind

Constructs the compatibility wire identity for a plugin event.

pub fn event_type(&self) -> &str

pub fn is_type(&self, event_type: &str) -> bool

pub fn fields(&self) -> BTreeMap<String, Value>

pub fn field(&self, name: &str) -> Option<Value>

pub fn set_field<T>( &mut self, name: &str, value: &T, ) -> Result<(), EventKindError>

where T: Serialize,

Replaces one existing field with a serializable value.

Errors

Returns an error when the field is absent or the value cannot be represented as structured JSON data.

pub fn decode_payload<T>(&self) -> Result<T, EventKindError>

where T: DeserializeOwned,

Decodes all flattened fields into a domain-owned payload type.

Errors

Returns an error when the fields do not deserialize as T.

pub fn decode_field<T>(&self, name: &str) -> Result<T, EventKindError>

where T: DeserializeOwned,

Decodes one named field.

Errors

Returns an error when the field is absent or does not deserialize as T.

pub fn plugin_identity(&self) -> Option<(&str, &str)>

pub fn qualified_event_type(&self) -> String

Returns the stable, display-oriented type identity for this event.

Built-in event kinds retain the same snake-case labels returned by Self::event_type. Plugin events are qualified with their registered plugin name and event type, separated by a dot. The two plugin-provided components are preserved as registered; no case folding or additional normalization is applied.

Trait Implementations

impl Clone for EventKind

fn clone(&self) -> EventKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventKind

fn deserialize<D>( deserializer: D, ) -> Result<EventKind, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EventKind

impl PartialEq for EventKind

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EventKind

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.