Skip to main content

IngestGroup

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
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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>

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

The same group, carrying the origin’s guard.

Trait Implementations§

§

impl<'a> Clone for IngestGroup<'a>

§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl<'a> Copy for IngestGroup<'a>

§

impl<'a> Debug for IngestGroup<'a>

§

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

Formats the value using the given formatter. Read more
§

impl<'a> Eq for IngestGroup<'a>

§

impl<'a> PartialEq for IngestGroup<'a>

§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
§

impl<'a> StructuralPartialEq for IngestGroup<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for IngestGroup<'a>

§

impl<'a> RefUnwindSafe for IngestGroup<'a>

§

impl<'a> Send for IngestGroup<'a>

§

impl<'a> Sync for IngestGroup<'a>

§

impl<'a> Unpin for IngestGroup<'a>

§

impl<'a> UnsafeUnpin for IngestGroup<'a>

§

impl<'a> UnwindSafe for IngestGroup<'a>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.