Struct ProtocolEnvelope 

pub struct ProtocolEnvelope {
    pub protocol_version: u32,
    pub message_type: u32,
    pub payload: Vec<u8>,
    pub payload_crc32: u32,
}

The versioned, checksummed form of every protocol message.

Fields

protocol_version: u32

Protocol version; see PROTOCOL_VERSION.

message_type: u32

Discriminant of the payload message; numbers are never reused.

payload: Vec<u8>

Encoded message payload. The envelope never interprets these bytes.

payload_crc32: u32

CRC-32 over version, type, length, and payload.

Implementations

impl ProtocolEnvelope

pub fn new(message_type: u32, payload: Vec<u8>) -> Self

Builds an envelope at the current protocol version, computing the checksum.

pub fn checksum(protocol_version: u32, message_type: u32, payload: &[u8]) -> u32

Computes the checksum covering version, type, length, and payload.

pub fn verify(&self) -> Result<(), EnvelopeError>

Fails closed unless the version is supported and the checksum matches.

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

Serializes to the canonical deterministic encoding: equal envelopes always produce byte-identical output.

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

Parses one envelope, verifying version and checksum (fails closed).

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 Eq for ProtocolEnvelope

impl PartialEq for ProtocolEnvelope

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

Equality operator ==.

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

Inequality operator !=.

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.

impl StructuralPartialEq for ProtocolEnvelope