Skip to main content

JournalEvent

Struct JournalEvent 

Source
pub struct JournalEvent { /* private fields */ }
Expand description

One committed, self-validating record in a run’s append-only journal.

digest is a domain-separated SHA-256 checksum over stable event metadata, the full intent checksum, payload checksum, and previous event checksum. It detects accidental corruption, omission, and reordering; an unkeyed hash chain is not proof against a privileged actor able to rewrite every record.

Implementations§

Source§

impl JournalEvent

Source

pub fn restore( intent: JournalEventIntent, sequence: JournalSequence, recorded_at: Timestamp, previous_digest: Option<Digest>, digest: Digest, ) -> Result<Self, JournalEventError>

Restores and verifies an event from durable storage columns.

The intent reconstructs and validates tenant, run, event identity, source, payload, payload checksum, and intent checksum. This method then validates sequence/predecessor shape and recomputes the complete event checksum before returning a usable event.

A store that persists redundant payload or intent digest columns must compare those columns with intent before calling this method.

§Errors

Returns JournalEventError when the sequence/predecessor shape or complete event checksum does not match the reconstructed event.

Source

pub fn commit( append: JournalAppend, recorded_at: Timestamp, ) -> Result<Self, JournalEventError>

Materializes a validated append after the store has won its transaction.

recorded_at must be the database observation selected while holding the current run row. For a non-empty journal it cannot precede the prior head; a store may clamp a regressing wall clock to the prior durable value while sequence remains the authoritative order.

§Errors

Returns JournalEventError for sequence exhaustion, clock regression, or an unexpected integrity serialization failure.

Source

pub const fn tenant_id(&self) -> &TenantId

Returns the tenant boundary.

Source

pub const fn run_id(&self) -> RunId

Returns the run journal identity.

Source

pub const fn sequence(&self) -> JournalSequence

Returns the one-based contiguous event sequence.

Source

pub const fn event_id(&self) -> EventId

Returns the stable idempotency identity.

Source

pub const fn recorded_at(&self) -> Timestamp

Returns the durable database clock observation.

Source

pub const fn source(&self) -> &JournalEventSource

Returns the trusted source marker.

Source

pub const fn payload(&self) -> &JournalPayload

Returns the schema-bound payload.

Source

pub const fn payload_digest(&self) -> Digest

Returns the RFC 8785 payload checksum.

Source

pub const fn intent_digest(&self) -> Digest

Returns the domain-separated append-intent checksum.

Source

pub const fn previous_digest(&self) -> Option<Digest>

Returns the immediately preceding event checksum, if any.

Source

pub const fn digest(&self) -> Digest

Returns this complete event’s domain-separated checksum.

Source

pub fn head(&self) -> JournalHead

Returns the exact durable head represented by this event.

Source

pub fn matches_intent(&self, intent: &JournalEventIntent) -> bool

Returns whether an idempotent retry is exactly the committed intent.

Trait Implementations§

Source§

impl Clone for JournalEvent

Source§

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
Source§

impl Debug for JournalEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for JournalEvent

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for JournalEvent

Source§

impl JsonSchema for JournalEvent

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for JournalEvent

Source§

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
Source§

impl Serialize for JournalEvent

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for JournalEvent

Auto Trait Implementations§

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> Same for T

Source§

type Output = T

Should always be Self
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.