Struct StoredEvent 

pub struct StoredEvent {
    pub sequence: u64,
    pub event_id: EventId,
    pub account_id: AccountId,
    pub case_key: CaseKey,
    pub case_revision: CaseRevision,
    pub command_id: CommandId,
    pub event_type: String,
    pub payload: Value,
    pub occurred_at: DateTime<Utc>,
    pub redaction: Option<EventRedaction>,
}

A committed event as persisted (spec §22.2, tf_domain_events).

Fields

sequence: u64

Store-assigned position in the journal, strictly increasing in append order across the whole store — not per case and not per account.

It is a position, not a count: nothing promises it has no gaps, only that a later append gets a higher one. EventCursor pages by it; see the module documentation for why the revision cannot.

event_id: EventId

Identifier in the ledger.

account_id: AccountId

Owning tenant.

case_key: CaseKey

The case.

case_revision: CaseRevision

Revision of the case produced by the commit that emitted the event.

command_id: CommandId

Command whose execution produced it.

event_type: String

Stable event type label.

payload: Value

Type-erased payload, or JSON null once it has been erased.

Self::redaction is what says which of the two it is; a domain whose event type legitimately serializes to null is not misread.

occurred_at: DateTime<Utc>

When it was committed.

redaction: Option<EventRedaction>

Present once the payload has been erased, saying when and on whose authority — never what was removed.

It defaults to absent, so a record written before this field existed reads back as an event whose payload is intact, which it is.

Implementations

impl StoredEvent

pub fn to_committed(&self) -> CommittedEvent<Value>

The core view of the event.

The payload comes back as it is stored, so an erased event yields a null payload here. Use Self::to_receipt_event wherever the caller has to tell the two apart, which is everywhere a receipt is rendered.

pub fn is_redacted(&self) -> bool

Returns true when the payload has been erased.

pub fn to_receipt_event(&self) -> ReceiptEvent<Value>

The event in the form a receipt renderer takes, which distinguishes a payload that is there from one that was erased.

Trait Implementations

impl Clone for StoredEvent

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 StoredEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StoredEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for StoredEvent

impl PartialEq for StoredEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StoredEvent

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 StoredEvent