Struct EntityEvents 

pub struct EntityEvents<T: EsEvent> {
    pub entity_id: <T as EsEvent>::EntityId,
    /* private fields */
}

A Vec wrapper that manages event-stream of an entity with helpers for event-sourcing operations

Provides event sourcing operations for loading, appending, and persisting events in chronological sequence. Required field for all event-sourced entities to maintain their state change history.

Fields

entity_id: <T as EsEvent>::EntityId

The entity’s id

Implementations

impl<T> EntityEvents<T>

where T: EsEvent,

pub fn init( id: <T as EsEvent>::EntityId, initial_events: impl IntoIterator<Item = T>, ) -> Self

Initializes a new EntityEvents instance with the given entity ID and initial events which is returned by IntoEvents method

pub fn id(&self) -> &<T as EsEvent>::EntityId

Returns a reference to the entity’s identifier

pub fn entity_first_persisted_at(&self) -> Option<DateTime<Utc>>

Returns the timestamp of the first persisted event, indicating when the entity was created

pub fn entity_last_modified_at(&self) -> Option<DateTime<Utc>>

Returns the timestamp of the last persisted event, indicating when the entity was last modified

pub fn push(&mut self, event: T)

Appends a single new event to the entity’s event stream to be persisted later

pub fn extend(&mut self, events: impl IntoIterator<Item = T>)

Appends multiple new events to the entity’s event stream to be persisted later

pub fn any_new(&self) -> bool

Returns true if there are any unpersisted events waiting to be saved

pub fn len_persisted(&self) -> usize

Returns the count of persisted events

pub fn iter_persisted( &self, ) -> impl DoubleEndedIterator<Item = &PersistedEvent<T>>

Returns an iterator over all persisted events

pub fn last_persisted(&self, n: usize) -> LastPersisted<'_, T>

Returns an iterator over the last n persisted events

pub fn iter_all(&self) -> impl DoubleEndedIterator<Item = &T>

Returns an iterator over all events (both persisted and new) in chronological order

pub fn load_first<E: EsEntity<Event = T>>( events: impl IntoIterator<Item = GenericEvent<<T as EsEvent>::EntityId>>, ) -> Result<E, EsEntityError>

Loads and reconstructs the first entity from a stream of GenericEvents, marking events as persisted

pub fn load_n<E: EsEntity<Event = T>>( events: impl IntoIterator<Item = GenericEvent<<T as EsEvent>::EntityId>>, n: usize, ) -> Result<(Vec<E>, bool), EsEntityError>

Loads and reconstructs up to n entities from a stream of GenericEvents. Assumes the events are grouped by id and ordered by sequence per id.

Returns both the entities and a flag indicating whether more entities were available in the stream.

Trait Implementations

impl<T: Clone + EsEvent> Clone for EntityEvents<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.