Struct DomainEvent 

pub struct DomainEvent<T> {
    pub event_id: Uuid,
    pub payload: T,
    pub occurred_at: DateTime<Utc>,
    pub version: u64,
    pub correlation_id: Option<Uuid>,
    pub causation_id: Option<Uuid>,
    pub metadata: HashMap<String, String>,
}

Generic domain event wrapper that provides consistent event metadata

This is the core event type that wraps all domain events in the system. It provides standardized metadata, correlation tracking, and serialization capabilities for event sourcing and distributed tracing.

Type Parameters

• T - The event payload type that contains the specific event data

Features

• Event Identification: Unique UUID for each event instance
• Timestamp Management: RFC3339 formatted timestamps for precise ordering
• Schema Versioning: Version tracking for event schema evolution
• Correlation Tracking: Distributed tracing with correlation and causation IDs
• Metadata Support: Extensible metadata for additional context
• Serialization: Full JSON serialization/deserialization support

Examples

Fields

event_id: Uuid

Unique identifier for this event instance

payload: T

The specific event payload containing event-specific data

occurred_at: DateTime<Utc>

When this event occurred (RFC3339 format for consistency)

version: u64

Event schema version for evolution support

correlation_id: Option<Uuid>

Optional correlation ID for tracing related events

causation_id: Option<Uuid>

Optional causation ID (the event that caused this event)

metadata: HashMap<String, String>

Event metadata for additional context

Implementations

impl<T> DomainEvent<T>

pub fn new(payload: T) -> Self

Creates a new domain event with the given payload

Arguments

• payload - The event-specific data

Returns

A new domain event with generated ID and current timestamp

pub fn new_with_correlation( payload: T, correlation_id: Option<Uuid>, causation_id: Option<Uuid>, ) -> Self

Creates a new domain event with correlation tracking

Arguments

• payload - The event-specific data
• correlation_id - ID to correlate related events
• causation_id - ID of the event that caused this event

Returns

A new domain event with correlation information

pub fn new_with_version(payload: T, version: u64) -> Self

Creates a new domain event with specific version

Arguments

• payload - The event-specific data
• version - Event schema version

Returns

A new domain event with specified version

pub fn with_metadata(self, key: String, value: String) -> Self

Adds metadata to the event

Arguments

• key - Metadata key
• value - Metadata value

Returns

Self for method chaining

pub fn with_correlation_id(self, correlation_id: Uuid) -> Self

Sets the correlation ID for this event

Arguments

• correlation_id - The correlation ID

Returns

Self for method chaining

pub fn with_causation_id(self, causation_id: Uuid) -> Self

Sets the causation ID for this event

Arguments

• causation_id - The causation ID

Returns

Self for method chaining

pub fn event_type(&self) -> &'static str

Gets the event type name for logging and routing

Returns

The type name of the payload

pub fn is_correlated_with(&self, other_correlation_id: Uuid) -> bool

Checks if this event is correlated with another event

Arguments

• other_correlation_id - The correlation ID to check against

Returns

True if the events are correlated

pub fn was_caused_by(&self, other_event_id: Uuid) -> bool

Checks if this event was caused by another event

Arguments

• other_event_id - The event ID to check against

Returns

True if this event was caused by the other event

Trait Implementations

impl<T: Clone> Clone for DomainEvent<T>

fn clone(&self) -> DomainEvent<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for DomainEvent<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for DomainEvent<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for DomainEvent<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.