Struct EventEnvelope 

#[non_exhaustive]
pub struct EventEnvelope {
    pub id: Uuid,
    pub event_type: String,
    pub aggregate_type: String,
    pub aggregate_id: Uuid,
    pub schema_version: u16,
    pub occurred_at: DateTime<Utc>,
    pub payload: Value,
    pub headers: BTreeMap<String, String>,
}

One event as it travels: the outbox row, a delivery, a Kafka message. Its id stays the same across redeliveries, so a handler deduplicates on it.

#[non_exhaustive]: built with EventEnvelope::new (a new event) or EventEnvelope::from_parts (one read back from a store), so a later field breaks no one.

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.

id: Uuid

event_type: String

aggregate_type: String

aggregate_id: Uuid

schema_version: u16

occurred_at: DateTime<Utc>

payload: Value

headers: BTreeMap<String, String>

Context that is not the event’s: correlation_id, later tenant_id.

Implementations

impl EventEnvelope

pub fn new(event: &impl DomainEvent) -> Self

A new event: the id is a UUID v7, so ids sort by the time they were made.

pub fn from_parts(parts: EnvelopeParts) -> Self

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

pub fn decode<T: DeserializeOwned>(&self) -> Result<T, DecodeError>

The payload as the snapshot type the consumer subscribed to.

Trait Implementations

impl Clone for EventEnvelope

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventEnvelope

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

Formats the value using the given formatter.

impl PartialEq for EventEnvelope

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EventEnvelope