Struct CommitBundle 

#[non_exhaustive]
pub struct CommitBundle {
    pub journal_completions: Vec<JournalCompletion>,
    pub events: Vec<EventBatch>,
    pub interaction_finishes: Vec<InteractionFinish>,
    pub interaction_invalidations: Vec<CaseInvalidation>,
    pub interaction_inserts: Vec<InteractionInsert>,
    pub outbox_entries: Vec<OutboxEntry>,
    pub replay_record: Option<ReplayRecord>,
    pub turn_phase: Option<TurnPhaseUpdate>,
}

Everything one commit writes, applied all or nothing.

Compared with PartialEq only, because the replay record it may carry holds a sampling temperature and therefore a float.

Fields (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.

journal_completions: Vec<JournalCompletion>

Journal outcomes to record.

events: Vec<EventBatch>

Event batches to append.

interaction_finishes: Vec<InteractionFinish>

Interactions to settle.

interaction_invalidations: Vec<CaseInvalidation>

Cases whose revision-bound interactions are invalidated.

interaction_inserts: Vec<InteractionInsert>

Interactions to insert.

outbox_entries: Vec<OutboxEntry>

Outbox rows to enqueue.

replay_record: Option<ReplayRecord>

Replay record to upsert.

turn_phase: Option<TurnPhaseUpdate>

Turn phase to write.

Implementations

impl CommitBundle

pub fn new() -> Self

An empty bundle.

pub fn with_journal_completion( self, command_id: CommandId, outcome: JournalOutcome, ) -> Self

Adds a journal completion.

pub fn with_events(self, batch: EventBatch) -> Self

Adds an event batch.

pub fn with_interaction_finish( self, interaction_id: InteractionId, outcome: ResolutionOutcome, ) -> Self

Adds an interaction finish.

pub fn with_invalidation( self, case_key: CaseKey, new_revision: CaseRevision, reason: InvalidationReason, ) -> Self

Adds a case invalidation.

pub fn with_interaction_insert( self, interaction: Interaction, replace_blocking: bool, ) -> Self

Adds an interaction insert.

pub fn with_outbox_entry(self, entry: OutboxEntry) -> Self

Adds an outbox entry.

pub fn with_replay_record(self, record: ReplayRecord) -> Self

Sets the replay record.

pub fn with_turn_phase(self, turn_id: TurnId, phase: TurnPhase) -> Self

Sets the turn phase update.

pub fn is_empty(&self) -> bool

Returns true when the bundle writes nothing.

pub fn validate(&self, account: &AccountId) -> Result<(), StoreError>

Checks the bundle before anything is written: every account-bearing item must belong to account, and no event batch may be empty.

Implementations call this first; adopters writing their own store should too, so a foreign item is refused identically everywhere.

Errors

• Other(BUNDLE_ACCOUNT_MISMATCH) for a foreign item.
• Other(INVALID_RECORD) for an empty event batch.

Trait Implementations

impl Clone for CommitBundle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommitBundle

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

Formats the value using the given formatter.

impl Default for CommitBundle

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CommitBundle

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CommitBundle

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CommitBundle

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommitBundle