Struct MessageEnvelope 

pub struct MessageEnvelope {
    pub schema_id: SchemaId,
    pub causal_context: CausalContext,
    pub payload: Vec<u8>,
}

Protocol message envelope carried by publish and conversation-message frames.

Fields

schema_id: SchemaId

Content type hash identifying the payload schema.

causal_context: CausalContext

Structured causal metadata used by the bus for ordering decisions.

payload: Vec<u8>

Opaque application payload bytes.

Implementations

impl MessageEnvelope

pub const fn new( schema_id: SchemaId, causal_context: CausalContext, payload: Vec<u8>, ) -> Self

Create a protocol message envelope from all of its fields.

pub fn encoded_len(&self) -> Result<usize, ProtocolError>

Return the deterministic encoded length of this envelope.

Errors

Returns ProtocolError::CodecError when the causal-context or payload length cannot fit in the protocol’s u32 length fields, or when the total length overflows usize.

pub fn serialize(&self) -> Result<Vec<u8>, ProtocolError>

Serialize this envelope with deterministic big-endian field encoding.

Errors

Returns ProtocolError::CodecError when a length field cannot represent the encoded envelope.

pub fn to_wire_bytes(&self) -> Result<Vec<u8>, ProtocolError>

Serialize this envelope for wire transport.

Errors

Returns ProtocolError::CodecError when a length field cannot represent the encoded envelope.

pub fn deserialize(bytes: &[u8]) -> Result<Self, ProtocolError>

Deserialize an envelope from deterministic wire bytes.

Errors

Returns ProtocolError::CodecError when the bytes are truncated, contain malformed causal context bytes, or contain trailing bytes.

pub fn from_wire_bytes(bytes: &[u8]) -> Result<Self, ProtocolError>

Deserialize an envelope from deterministic wire bytes.

Errors

Returns ProtocolError::CodecError when the bytes are truncated, contain malformed causal context bytes, or contain trailing bytes.

Trait Implementations

impl Clone for MessageEnvelope

fn clone(&self) -> MessageEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageEnvelope

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

Formats the value using the given formatter.

impl Eq for MessageEnvelope

impl PartialEq for MessageEnvelope

fn eq(&self, other: &MessageEnvelope) -> 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 StructuralPartialEq for MessageEnvelope