Struct cqrs_es::EventEnvelope

pub struct EventEnvelope<A, E> where
    A: Aggregate,
    E: DomainEvent<A>,  {
    pub aggregate_id: String,
    pub sequence: usize,
    pub aggregate_type: String,
    pub payload: E,
    pub metadata: HashMap<String, String>,
    // some fields omitted
}

EventEnvelope is a data structure that encapsulates an event with along with it's pertinent information. All of the associated data will be transported and persisted together.

Within any system an event must be unique based on its' aggregate_type, aggregate_id and sequence.

Fields

aggregate_id: String

The id of the aggregate instance.

sequence: usize

The sequence number for an aggregate instance.

aggregate_type: String

The type of aggregate the event applies to.

payload: E

The event payload with all business information.

metadata: HashMap<String, String>

Additional metadata for use in auditing, logging or debugging purposes.

Methods

impl<A, E> EventEnvelope<A, E> where
    A: Aggregate,
    E: DomainEvent<A>, 

pub fn new(
    aggregate_id: String,
    sequence: usize,
    aggregate_type: String,
    payload: E
) -> Self

A convenience function for packaging an event in an EventEnvelope, used for testing QueryProcessors.

pub fn new_with_metadata(
    aggregate_id: String,
    sequence: usize,
    aggregate_type: String,
    payload: E,
    metadata: HashMap<String, String>
) -> Self

A convenience function for packaging an event in an EventEnvelope, used for testing QueryProcessors. This version allows custom metadata to also be processed.

Trait Implementations

impl<A, E> Clone for EventEnvelope<A, E> where
    A: Aggregate,
    E: DomainEvent<A>, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug, E: Debug> Debug for EventEnvelope<A, E> where
    A: Aggregate,
    E: DomainEvent<A>, 

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

Formats the value using the given formatter.