Struct NativeUFrameEnvelope

pub struct NativeUFrameEnvelope;

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

The envelope mirrors the physical layout the shared-memory transports already use — a small fixed placement header followed by the variable canonical metadata field block, followed by the payload bytes:

offset  size  field
0       4     magic "UPFE"
4       1     envelope version (1)
5       1     payload presence (0 = absent, 1 = present)
6       2     reserved, MUST be zero
8       4     metadata_len (u32, little-endian)
12      8     payload_len (u64, little-endian; 0 when absent)
20      ...   metadata field block (see [`crate::frame::codec`])
20+m    ...   payload bytes

This is the recommended carrier for native frames over ordinary byte channels (an MQTT payload, a SOME/IP payload, a Zenoh attachment+payload pair collapsed into one buffer, a file, …). Unlike ProtobufUMessageFrame it preserves open payload encodings and does not require protobuf support.

Trait Implementations

impl Debug for NativeUFrameEnvelope

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

Formats the value using the given formatter.

impl UFrameWireFormat for NativeUFrameEnvelope

fn name() -> &'static str

Stable implementation name for logs, diagnostics, and configuration.

fn content_type() -> &'static str

Media type of bytes emitted by Self::serialize_frame.

fn serialize_frame(frame: &UOwnedFrame) -> Result<Bytes, UFrameWireError>

Serializes a complete native frame, including metadata and payload bytes.

fn deserialize_frame(src: &[u8]) -> Result<UOwnedFrame, UFrameWireError>

Deserializes a complete native frame from this wire format’s bytes.