Struct Envelope 

pub struct Envelope { /* private fields */ }

A complete weir wire frame: validated header + payload bytes.

Fields are private and read-only (header / payload). Envelope::new makes the payload authoritative for header.payload_len, so the declared length and the actual payload can never disagree.

Implementations

impl Envelope

pub fn new(header: Header, payload: impl Into<Payload>) -> Self

Builds a frame from a header and payload. The header’s payload_len is overwritten with the payload’s actual length, so the two cannot desync — the payload is the single source of truth for the length on the wire.

pub fn header(&self) -> Header

The frame’s validated Header.

pub fn payload(&self) -> &Payload

The frame’s payload bytes.

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

Serialises the full frame: header bytes + payload bytes + payload CRC32 (LE).

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

Decodes and validates a complete frame from a byte slice.

Validation order defends against pre-allocation DoS:

1. Buffer length >= HEADER_LEN — check before any parsing.
2. Header decode (magic → version → CRC) — before touching payload.
3. payload_len <= MAX_PAYLOAD_HARD_CAP — rejection before any heap allocation.
4. Buffer length == HEADER_LEN + payload_len + 4 — the buffer must be exactly one frame: shorter is TruncatedFrame, longer is TrailingBytes (the caller owns framing; the codec never silently discards a remainder — G18).
5. Payload CRC — validate after allocation, before returning data to caller.

The socket layer applies an additional cap (min(config.max_payload_bytes, MAX_PAYLOAD_HARD_CAP)) before reaching this function. This function applies only the hard cap as a safety floor.

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Self

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: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Envelope