Struct IntegrationEventEnvelope 

pub struct IntegrationEventEnvelope {
    pub id: String,
    pub event_type: String,
    pub source_context: String,
    pub aggregate_id: String,
    pub occurred_at: DateTime<Utc>,
    pub published_at: DateTime<Utc>,
    pub version: u32,
    pub correlation_id: Option<String>,
    pub causation_id: Option<String>,
    pub payload: Value,
}

Type-erased integration event envelope for cross-module transport

The envelope wraps any integration event with metadata and serializes the event payload to JSON for transport between bounded contexts.

Fields

• id: Unique envelope ID (UUID)
• event_type: Dot-notation event type
• source_context: Origin bounded context
• payload: JSON-serialized event data

Example

let event = UserCreatedIntegrationEvent { ... };
let envelope = IntegrationEventEnvelope::from_event(&event)?;

// Later, deserialize back to the typed event
let restored: UserCreatedIntegrationEvent = envelope.deserialize()?;

Fields

id: String

Unique envelope ID

event_type: String

Event type (e.g., “sapiens.user.created”)

source_context: String

Source bounded context

aggregate_id: String

Aggregate ID in source context

occurred_at: DateTime<Utc>

When the event occurred

published_at: DateTime<Utc>

When the envelope was created/published

version: u32

Event schema version

correlation_id: Option<String>

Correlation ID for distributed tracing

causation_id: Option<String>

Causation ID (parent event/envelope that caused this one)

payload: Value

JSON-serialized event payload

Implementations

impl IntegrationEventEnvelope

pub fn from_event<E: IntegrationEvent>(event: &E) -> Result<Self, Error>

Create an envelope from an integration event

Serializes the event to JSON and wraps it with metadata.

Errors

Returns serde_json::Error if the event cannot be serialized.

pub fn deserialize<E: IntegrationEvent>(&self) -> Result<E, Error>

Deserialize the payload back to a typed event

Errors

Returns serde_json::Error if the payload doesn’t match the expected type.

pub fn with_causation_id(self, causation_id: impl Into<String>) -> Self

Set the causation ID (for event chaining)

pub fn with_correlation_id(self, correlation_id: impl Into<String>) -> Self

Set the correlation ID (for distributed tracing)

pub fn matches_pattern(&self, pattern: &str) -> bool

Check if this envelope matches a pattern

Patterns support:

• Exact match: “sapiens.user.created”
• Wildcard suffix: “sapiens.user.*” matches “sapiens.user.created”, “sapiens.user.deleted”
• Global wildcard: “*” matches everything

Trait Implementations

impl Clone for IntegrationEventEnvelope

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 IntegrationEventEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IntegrationEventEnvelope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for IntegrationEventEnvelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.