Struct IngestGroup
#[non_exhaustive]pub struct IngestGroup<'a> {
pub events: &'a [ReplicatedEvent],
pub compensation: &'a [Event],
pub guard: Option<&'a AppendCondition>,
}Expand description
One atomic unit of an ingest: foreign events, and
the local compensation this side writes for them.
Borrowed rather than owned. The runner already holds the pulled batch, and
an ingest that took Vecs would make it clone every payload to hand them
over for the length of one call.
#[non_exhaustive], so a group is built with IngestGroup::new outside
this crate, and guard joined it without breaking a literal.
The guard is evidence (SY-6): stored with the group, never evaluated, and
handed back by read_groups.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.events: &'a [ReplicatedEvent]Events another store minted, each carrying its origin identity and recorded time.
compensation: &'a [Event]Events this store writes in answer to them, minted here.
Written in the same transaction as events (SY-2), and
only when at least one of those was new (SY-11). Empty for a group that
needs no answer, which is most of them.
guard: Option<&'a AppendCondition>The condition the origin wrote events under: evidence
only, never evaluated (SY-1, SY-6).
A store that implements WriteGroupStore
keeps it with the group, so a relay forwards it with the events (SY-30).
Implementations§
§impl<'a> IngestGroup<'a>
impl<'a> IngestGroup<'a>
pub const fn new(
events: &'a [ReplicatedEvent],
compensation: &'a [Event],
) -> Self
pub const fn new( events: &'a [ReplicatedEvent], compensation: &'a [Event], ) -> Self
A group of foreign events, answered by compensation, carrying no
guard.
pub const fn with_guard(self, guard: Option<&'a AppendCondition>) -> Self
pub const fn with_guard(self, guard: Option<&'a AppendCondition>) -> Self
The same group, carrying the origin’s guard.