Struct EnvelopeBuilder 

pub struct EnvelopeBuilder { /* private fields */ }

Builder for creating protocol envelopes.

Determinism

By default, envelopes are created with timestamp_ns = 0 for deterministic simulation. Use timestamp() to set an explicit timestamp, or timestamp_now() for production use with real wall-clock time.

Implementations

impl EnvelopeBuilder

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

Set the protocol name.

pub fn sender(self, role: RoleName) -> Self

Set the sender role.

pub fn sender_role<R: RoleId>(self, role: R) -> Self

Set the sender role from a typed role identifier.

pub fn sender_index(self, index: u32) -> Self

Set the sender role index.

pub fn recipient(self, role: RoleName) -> Self

Set the receiver role.

pub fn recipient_role<R: RoleId>(self, role: R) -> Self

Set the receiver role from a typed role identifier.

pub fn recipient_index(self, index: u32) -> Self

Set the receiver role index.

pub fn message_type(self, msg_type: impl Into<String>) -> Self

Set the message type name.

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

Set the sequence number.

pub fn timestamp(self, timestamp_ns: u64) -> Self

Set an explicit timestamp (nanoseconds since epoch).

For deterministic simulation, use controlled timestamps (or leave unset to default to 0). For production contexts with real timestamps, use SystemClock::timestamp_ns() from the utility layer.

pub fn timestamp_from<C: WallClock>(self, clock: &C) -> Self

Set timestamp from an injected wall-clock source.

Use this instead of reading host time directly to keep determinism under explicit control in simulations/replays.

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

Set the correlation ID.

pub fn payload(self, payload: Vec<u8>) -> Self

Set the payload bytes directly.

pub fn payload_from<T: Serialize>(self, msg: &T) -> Result<Self, EnvelopeError>

Serialize a message as the payload.

pub fn build(self) -> Result<ProtocolEnvelope, EnvelopeError>

Build the envelope.

Trait Implementations

impl Debug for EnvelopeBuilder

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

Formats the value using the given formatter.

impl Default for EnvelopeBuilder

fn default() -> EnvelopeBuilder

Returns the “default value” for a type.