Struct esrs::AggregateState

pub struct AggregateState<S> { /* private fields */ }

The internal state for an Aggregate. It contains:

• an id uniquely representing the aggregate,
• an incremental sequence number,
• a lock representing the atomicity of the access to the aggregate,
• a state defined by the user of this library.

Implementations

impl<S: Default> AggregateState<S>

pub fn new() -> Self

Creates a new instance of an AggregateState with a new unique id.

pub fn with_id(id: impl Into<Uuid>) -> Self

Creates a new instance of an AggregateState with the given aggregate id.

This should be used almost exclusively when loading by aggregate id yields nothing, and this becomes the brand new aggregate state for that id.

Other uses are strongly discouraged, since the id could be already existing and a clash might happen when persisting events.

pub fn apply_store_events<T, F>( self, store_events: Vec<StoreEvent<T>>, apply_event: F ) -> Self

where F: Fn(S, T) -> S,

Consumes the aggregate state and generates a new one with the events applied to it, as dictated by apply_event.

pub const fn id(&self) -> &Uuid

Returns an Uuid representing the aggregate id.

pub const fn inner(&self) -> &S

Returns the internal state.

pub fn into_inner(self) -> S

Consumes self and extracts the internal state.

pub const fn sequence_number(&self) -> &SequenceNumber

Returns the internal sequence number.

pub fn next_sequence_number(&mut self) -> SequenceNumber

Computes the internal sequence number incremented by 1.

pub fn set_lock(&mut self, guard: EventStoreLockGuard)

Inserts the lock guard into self, replacing any current one.

pub fn take_lock(&mut self) -> Option<EventStoreLockGuard>

Extracts the lock from self, leaving nothing behind.

Trait Implementations

impl<S: Debug> Debug for AggregateState<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for AggregateState<S>

Default implementation for AggregateState

fn default() -> Self

Returns the “default value” for a type.