Module envelope

Whole-frame envelopes

A whole-frame envelope serializes semantic metadata and application payload into one envelope byte value. It is distinct from selected-wire UPWM, which prefixes a configured metadata profile while the encoded core carries payload storage separately.

Walkthrough

1. Start with a validated UOwnedFrame.
2. Use NativeUFrameEnvelope::serialize_frame when open payload identities must survive losslessly. Use ProtobufUMessageFrame only for legacy compatibility and accept its representability checks.
3. Carry the resulting bytes through an ordinary byte channel.
4. Deserialize with the same UFrameWireFormat; malformed lengths, reserved fields, metadata, payload presence, and unsupported identities fail before a frame is returned.
5. Verify changes with the envelope round-trip, malformed-input, and projection tests in this module.

Structs

NativeUFrameEnvelope

Canonical whole-frame envelope carrying native frame metadata and payload bytes with full fidelity.

ProtobufUMessageFrame

Legacy compatibility whole-frame wire format using the generated UMessage Protocol Buffers envelope.

Enums

UFrameWireError

Error type used by whole-frame wire formats.

Constants

NATIVE_ENVELOPE_HEADER_LEN

Size of the fixed native-envelope placement header in bytes.

NATIVE_ENVELOPE_MAGIC

Magic bytes of the native whole-frame envelope.

NATIVE_ENVELOPE_VERSION

Version of the native whole-frame envelope emitted by this module.

Traits

UFrameWireFormat

Whole-frame wire format for transporting a complete native uProtocol frame.