Module krill::commons::eventsourcing

Event sourcing support for Krill

Macros

• namespace
  Macro to provide a safe way to create a &Namespace at compile-time.
• segment
  Macro to provide a safe way to create a &Segment at compile-time.

Structs

• AggregateStore
  This type is responsible for managing aggregates.
• EventCounter
  Example listener that simply counts all events
• Key
  Represents the key used in KVx. Consists of a scope of type Scope and a name of type SegmentBuf.
• KeyValueStore
• Namespace
  A string slice representing a namespace.
• Scope
  Used to scope a Key. Consists of a vector of zero or more SegmentBufs.
• Segment
  A nonempty string slice that does not start or end with whitespace and does not contain any instances of Scope::SEPARATOR.
• SegmentBuf
  A nonempty string that does not start or end with whitespace and does not contain any instances of Scope::SEPARATOR.
• SentCommand
  Convenience wrapper so that implementations can just implement [‘CommandDetails’] and leave the id and version boilerplate.
• SentInitCommand
  Convenience wrapper so that implementations can just implement [‘InitCommandDetails’] and leave the id and version boilerplate.
• StoredCommand
  A description of a command that was processed, and the events / or error that followed. Commands that turn out to be no-ops (no events, no errors) should not be stored.
• StoredCommandBuilder
  Helper to create StoredCommand instances that will contain the atomic change sets for Aggregates.
• WalSet
  Describes a set of “write-ahead” changes affecting the specified revision. Meaning that it can only be applied if the type is of the given revision, and it will get this revision + 1 after it has been applied.
• WalStore
  This type is responsible for loading / saving and updating WalSupport capable types.

Enums

• AggregateStoreError
  This type defines possible Errors for the AggregateStore
• KeyValueError
  This type defines possible Errors for KeyStore
• StoredEffect
• WalStoreError
  This type defines possible Errors for the AggregateStore

Traits

• Aggregate
  This trait defines an Aggregate for use with the event sourcing framework.
• Command
  Commands are used to send an intent to change an aggregate.
• CommandDetails
  Implement this for an enum with CommandDetails, so you you can reuse the id and version boilerplate from [‘SentCommand’].
• Event
• InitCommand
  The InitCommand is used to create an aggregate.
• InitCommandDetails
  Implement this for an enum with CommandDetails, so you you can reuse the id and version boilerplate from [‘SentCommand’].
• InitEvent
• PostSaveEventListener
  This trait defines a listener for events which is designed to receive them after the updated Aggregate is saved. Because the updates already happened EventListeners of this type are not allowed to fail.
• PreSaveEventListener
  This trait defines a listener for events which is designed to receive the events before the Aggregate is saved. Thus, they are allowed to return an error in case of issues, which will then roll back the intended change to an aggregate.
• SegmentExt
• Storable
• WalChange
• WalCommand
• WalSupport
  Implement this trait to get write-ahead logging support for a type.
• WithStorableDetails
  Must be implemented for all ‘StorableDetails’ used in Commands.

Type Aliases

• StoreResult
• WalStoreResult