Skip to main content

SyncEvent

Struct SyncEvent 

Source
pub struct SyncEvent {
    pub id: Uuid,
    pub sequence: u64,
    pub event_type: String,
    pub entity_type: String,
    pub entity_id: String,
    pub payload: Value,
    pub hash: String,
    pub signature: Option<String>,
    pub timestamp: DateTime<Utc>,
}
Expand description

A sync event representing a state change in the system.

This is the Rust equivalent of the JS OutboxEvent and the VES v1.0 event envelope. Events are immutable once created.

§Examples

use stateset_sync::SyncEvent;
use serde_json::json;

let event = SyncEvent::new(
    "order.created",
    "order",
    "ORD-123",
    json!({"total": 99.99}),
);
assert_eq!(event.event_type, "order.created");
assert_eq!(event.entity_type, "order");
assert!(!event.hash.is_empty());

Fields§

§id: Uuid

Unique event identifier.

§sequence: u64

Monotonically increasing sequence number (0 = unassigned).

§event_type: String

The type of event (e.g. order.created, inventory.adjusted).

§entity_type: String

The entity type this event applies to (e.g. order, customer).

§entity_id: String

The identifier of the entity.

§payload: Value

The event payload as a JSON value.

§hash: String

SHA-256 hash of the canonicalized payload (hex-encoded).

§signature: Option<String>

Optional cryptographic signature (hex-encoded Ed25519).

§timestamp: DateTime<Utc>

Timestamp when the event was created.

Implementations§

Source§

impl SyncEvent

Source

pub fn new( event_type: impl Into<String>, entity_type: impl Into<String>, entity_id: impl Into<String>, payload: Value, ) -> Self

Create a new SyncEvent with an auto-generated id, hash, and timestamp.

Source

pub fn with_id( id: Uuid, sequence: u64, event_type: impl Into<String>, entity_type: impl Into<String>, entity_id: impl Into<String>, payload: Value, timestamp: DateTime<Utc>, ) -> Self

Create a SyncEvent with an explicit id and sequence.

Source

pub fn compute_hash(payload: &Value) -> String

Compute the SHA-256 hash of a JSON payload, hex-encoded.

Source

pub const fn with_sequence(self, sequence: u64) -> Self

Assign a sequence number to this event, returning a new event.

Source

pub fn with_signature(self, signature: impl Into<String>) -> Self

Set the signature on this event.

Trait Implementations§

Source§

impl Clone for SyncEvent

Source§

fn clone(&self) -> SyncEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SyncEvent

Source§

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

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

impl<'de> Deserialize<'de> for SyncEvent

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 Ord for SyncEvent

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for SyncEvent

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for SyncEvent

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for SyncEvent

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 Eq for SyncEvent

Source§

impl StructuralPartialEq for SyncEvent

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> 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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,