Struct Message 

pub struct Message { /* private fields */ }

Pure wire data: {id, payload, context, audit_trail, errors}, in that order.

Read from JSON as v3’s is: the five fields, each required, any other key ignored. Its context reads by Context’s rules, so a fourth root is refused, and each root must be an object: a root takes only an object, and a null or scalar metadata would silently drop every write under it, metadata.progress included (3.x took any value).

Implementations

impl Message

pub fn new(payload: impl Into<Arc<OwnedDataValue>>) -> Self

A message with a fresh UUID v7 id, as v3. Ids made on one thread sort in the order they were made; ids made in the same millisecond on two threads are distinct but not ordered. A payload passed as an Arc is shared, not copied: messages built from one Arc hold one payload.

pub fn from_parts( payload: impl Into<Arc<OwnedDataValue>>, data: OwnedDataValue, metadata: OwnedDataValue, ) -> Self

A message seeded with data and metadata. A seed that is not an object is ignored, as v3. A payload passed as an Arc is shared, not copied.

pub fn from_json(payload: &Value) -> Self

A message whose payload is payload, converted.

pub fn with_id(self, id: impl Into<String>) -> Self

Replaces the id.

pub fn id(&self) -> &str

The id: a UUID v7 unless set.

pub fn payload(&self) -> &OwnedDataValue

The payload the message arrived with. It is not part of the evaluation context.

pub fn context(&self) -> &Context

The context.

pub fn context_mut(&mut self) -> &mut Context

The context, mutably.

pub fn audit(&self) -> &[AuditEntry]

The audit entries the run kept.

pub fn errors(&self) -> &[ErrorRecord]

The errors recorded while processing.

pub fn to_json(&self) -> Value

The message as a JSON value holding id, payload, context, audit_trail and errors.

Its keys are in wire order: the crate turns on serde_json’s preserve_order. The wire text is serde_json::to_string(&message).

Trait Implementations

impl Clone for Message

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 Message

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Message

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Message

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Message

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 Message