Struct ProtocolEnvelope 

pub struct ProtocolEnvelope {
    pub protocol: String,
    pub from_role: RoleName,
    pub from_index: Option<u32>,
    pub to_role: RoleName,
    pub to_index: Option<u32>,
    pub message_type: String,
    pub sequence: u64,
    pub timestamp_ns: u64,
    pub correlation_id: Option<String>,
    pub payload: Vec<u8>,
}

A protocol message envelope containing metadata and payload.

Envelopes provide a standard wrapper for messages that includes routing information and can be inspected without deserializing the payload.

Fields

protocol: String

Name of the protocol this message belongs to.

from_role: RoleName

Role sending the message.

from_index: Option<u32>

Role index if the sender is a parameterized role.

to_role: RoleName

Role receiving the message.

to_index: Option<u32>

Role index if the receiver is a parameterized role.

message_type: String

Type name of the message payload.

sequence: u64

Sequence number for ordering (per sender-receiver pair).

timestamp_ns: u64

Timestamp when the message was created (nanoseconds since epoch).

correlation_id: Option<String>

Correlation ID for tracing across roles.

payload: Vec<u8>

The serialized message payload.

Implementations

impl ProtocolEnvelope

pub fn builder() -> EnvelopeBuilder

Create a new envelope builder.

pub fn payload_size(&self) -> usize

Get the payload size in bytes.

pub fn is_protocol(&self, name: &str) -> bool

Check if this envelope is for a specific protocol.

pub fn is_from(&self, role: &RoleName) -> bool

Check if this envelope is from a specific role.

pub fn is_to(&self, role: &RoleName) -> bool

Check if this envelope is to a specific role.

pub fn routing_key(&self) -> String

Create a routing key for this envelope (useful for message queues).

pub fn to_bytes(&self) -> Result<Vec<u8>, EnvelopeError>

Serialize the envelope to bytes.

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

Deserialize an envelope from bytes.

Trait Implementations

impl Clone for ProtocolEnvelope

fn clone(&self) -> ProtocolEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProtocolEnvelope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProtocolEnvelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.