Struct ChangeEnvelope 

pub struct ChangeEnvelope { /* private fields */ }

Canonical sync event stored in the journal and passed to planners.

Implementations

impl ChangeEnvelope

pub const fn new( sync_key: SyncKey, source: SourceSystem, operation: ChangeOperation, observed_at: DateTime<Utc>, payload: Value, ) -> Self

Creates a new change envelope with no replay cursor.

pub fn with_cursor(self, cursor: SourceCursor) -> Self

Attaches a replay cursor to the envelope.

pub const fn sync_key(&self) -> &SyncKey

Returns the canonical record identity.

pub const fn source(&self) -> SourceSystem

Returns the source system for the change.

pub const fn operation(&self) -> ChangeOperation

Returns the operation carried by the change.

pub const fn cursor(&self) -> Option<&SourceCursor>

Returns the source cursor, if available.

pub const fn observed_at(&self) -> DateTime<Utc>

Returns when the change was observed by the sync engine.

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

Returns the raw change payload.

pub fn payload_hash(&self) -> [u8; 32]

Returns a stable hash for the payload contents.

pub fn payload_hash_matches(&self, other: &Value) -> bool

Returns true when the provided payload hashes to the same value.

Trait Implementations

impl Clone for ChangeEnvelope

fn clone(&self) -> ChangeEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChangeEnvelope

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

Formats the value using the given formatter.

impl PartialEq for ChangeEnvelope

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ChangeEnvelope

impl StructuralPartialEq for ChangeEnvelope