Struct Envelope 

pub struct Envelope {
    pub pattern: PatternId,
    pub correlation: CorrelationId,
    pub kind: MessageKind,
    pub payload: Value,
}

One decoded, validated conversation envelope.

Fields

pattern: PatternId

Nominal pattern contract, matched exactly.

correlation: CorrelationId

Typed correlation identity, caller-unique per exchange.

kind: MessageKind

Message kind within the pattern’s closed set.

payload: Value

The pattern’s typed message, as its JSON value.

Implementations

impl Envelope

pub fn from_typed<T: Serialize>( pattern: PatternId, correlation: CorrelationId, kind: MessageKind, body: &T, ) -> Result<Self, EnvelopeError>

Builds an envelope from a typed message, refusing schema-invalid values BEFORE the wire (F-3a R1).

Errors

Returns slug::CONV_SCHEMA_INVALID when the typed value does not serialize, and slug::CONV_KIND_INVALID when kind is outside the pattern’s closed kind set.

pub fn decode_payload<T: DeserializeOwned>(&self) -> Result<T, EnvelopeError>

Decodes this envelope’s payload into the pattern’s typed message.

Errors

Returns slug::CONV_SCHEMA_INVALID when the payload is not a valid value of the typed message — surfaced typed, never dropped (F-3a R1).

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

Encodes the envelope to its deterministic wire bytes.

Errors

Returns slug::CONV_ENVELOPE_MALFORMED if JSON encoding fails — unreachable for the envelope grammar, surfaced typed rather than swallowed if the impossible happens.

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

Decodes and validates wire bytes into a typed envelope.

Errors

Returns the closed refusal set: slug::CONV_ENVELOPE_MALFORMED for bytes that are not the wire shape (unknown fields refused — the refuse-non-canonical-receiver discipline), slug::CONV_PATTERN_UNKNOWN for a pattern outside the contract set, slug::CONV_CORRELATION_INVALID for a correlation that is not a typed correlation identity, and slug::CONV_KIND_INVALID for a kind outside the named pattern’s closed set.

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Envelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Envelope

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

Formats the value using the given formatter.

impl Eq for Envelope

impl PartialEq for Envelope

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Envelope