Struct Commit 

pub struct Commit<S, E> {
    pub state: Option<S>,
    pub new_revision: CaseRevision,
    pub events: Vec<CommittedEvent<E>>,
    pub idempotency_replay: bool,
}

Result of executing a command batch (spec §17.1).

Fields

state: Option<S>

State after the commit, or None when the case no longer exists.

None is written as a missing key, so a State type that itself serializes to JSON null ((), an empty newtype, an Option field at the root) reads back as “the case is gone”. A workflow state must therefore serialize to an object; the same rule holds for WorkflowDefinition::Outcome, whose erased form drives ErasedWorkflowView::is_complete. Concrete serde_json::Value fields that must keep an explicit null use FieldValue instead.

new_revision: CaseRevision

Revision after the commit.

events: Vec<CommittedEvent<E>>

Events committed by this batch.

idempotency_replay: bool

true when the executor recognised the idempotency key and returned the original outcome without repeating the effect (I14).

Implementations

impl<S, E> Commit<S, E>

pub fn event_ids(&self) -> Vec<EventId>

Identifiers of all committed events.

pub fn event_refs(&self) -> Vec<EventRef>

Lightweight references to all committed events.

impl<S, E: Clone> Commit<S, E>

pub fn receipt_events(&self) -> Vec<ReceiptEvent<E>>

The commit’s events in the form WorkflowDefinition::receipts takes.

Every event of a fresh commit still has its payload, so this is the whole conversion: a ReceiptEvent::Redacted only ever comes back out of the store, never out of an execution.

Trait Implementations

impl<S: Clone, E: Clone> Clone for Commit<S, E>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug, E: Debug> Debug for Commit<S, E>

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

Formats the value using the given formatter.

impl<'de, S, E> Deserialize<'de> for Commit<S, E>

where S: Deserialize<'de> + Default, E: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S: Eq, E: Eq> Eq for Commit<S, E>

impl<S: PartialEq, E: PartialEq> PartialEq for Commit<S, E>

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

Equality operator ==.

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

Inequality operator !=.

impl<S, E> Serialize for Commit<S, E>

where S: Serialize, E: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S: PartialEq, E: PartialEq> StructuralPartialEq for Commit<S, E>