Struct WireEnvelope 

pub struct WireEnvelope<T> {
    pub wire_version: u32,
    pub payload: T,
}

Versioned wrapper around a hybrid-flow payload.

JSON shape:

{"wire_version":1,"payload":"Ping"}

Transport ownership is unchanged: backends still send and receive bytes. Call WireEnvelope::decode_json or decode_ipc_message_json at the decode entry point so too-old / too-new envelopes fail before the payload is used.

Fields

wire_version: u32

Schema version of payload.

payload: T

Typed hybrid-flow message (typically IpcMessage).

Implementations

impl<T> WireEnvelope<T>

pub fn new(payload: T) -> Self

Wrap payload at WireCompatibility::CURRENT.

pub fn into_payload(self) -> T

Unwrap the payload after a successful decode.

impl<T: DeserializeOwned> WireEnvelope<T>

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

Decode JSON bytes, checking wire_version before converting payload.

The payload is kept as raw JSON until the version is accepted, so a too-new/too-old envelope is rejected without building T.

pub fn from_json_value(value: Value) -> Result<Self, EnvelopeError>

Decode an already-parsed JSON value, checking version before T.

Prefer Self::decode_json for byte input so the payload is not first materialized as a Value tree. This entry point exists for callers that already hold a Value.

impl<T: Serialize> WireEnvelope<T>

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

Encode this envelope as compact JSON bytes.

Trait Implementations

impl<T: Clone> Clone for WireEnvelope<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for WireEnvelope<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for WireEnvelope<T>

where T: DeserializeOwned,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for WireEnvelope<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T> Serialize for WireEnvelope<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for WireEnvelope<T>