Struct cqrs_es::EventEnvelope

pub struct EventEnvelope<A>where
    A: Aggregate,{
    pub aggregate_id: String,
    pub sequence: usize,
    pub payload: A::Event,
    pub metadata: HashMap<String, String>,
}

Expand description

EventEnvelope is a data structure that encapsulates an event with its pertinent information. All of the associated data will be transported and persisted together and will be available for queries.

Within any system an event must be unique based on the compound key composed of its:

aggregate_type
aggregate_id
sequence

Thus an EventEnvelope provides a uniqueness value along with an event payload and metadata.

Fields§

§aggregate_id: String

The id of the aggregate instance.

§sequence: usize

The sequence number for an aggregate instance.

§payload: A::Event

The event payload with all business information.

§metadata: HashMap<String, String>

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

Trait Implementations§

impl<A: Aggregate> Clone for EventEnvelope<A>

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<A> Debug for EventEnvelope<A>
where A: Aggregate + Debug, A::Event: Debug,

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

Formats the value using the given formatter. Read more

impl<A: Aggregate> TryFrom<&EventEnvelope<A>> for SerializedEvent

type Error = PersistenceError

The type returned in the event of a conversion error.

fn try_from(event: &EventEnvelope<A>) -> Result<Self, Self::Error>

Performs the conversion.

impl<A: Aggregate> TryFrom<SerializedEvent> for EventEnvelope<A>

type Error = PersistenceError

The type returned in the event of a conversion error.

fn try_from(event: SerializedEvent) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

impl<A> RefUnwindSafe for EventEnvelope<A>
where <A as Aggregate>::Event: RefUnwindSafe,

impl<A> Send for EventEnvelope<A>

impl<A> Sync for EventEnvelope<A>

impl<A> Unpin for EventEnvelope<A>
where <A as Aggregate>::Event: Unpin,

impl<A> UnwindSafe for EventEnvelope<A>
where <A as Aggregate>::Event: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.