Preview of the proposed up-rust native-frame-model branch (up-rust b6b99c6d, up-spec f0e9b17) — not released documentation. branch · write-up

Module metadata

Source
Expand description

Clean semantic native frame metadata.

UFrameMetadata is the canonical metadata model for native uProtocol frames (owned frames, zero-copy frame views, and selected-wire paths). It carries semantic fields directly and contains no legacy UAttributes, no UPayloadFormat, and no protobuf concepts.

Legacy compatibility lives at the edges of this module as fallible projections:

Projections fail — they never truncate or silently drop information — when the target model cannot represent the source (for example a native PayloadEncoding that has no legacy UPayloadFormat equivalent).

Fixed-layout representations of this metadata (for C/C++ shared-memory interop) are derived profiles, not this type: see the frame::abi module. Byte serializations for transports are produced by selected-wire metadata codecs: see the wire module.

Structs§

PayloadEncoding
Open identity of the payload representation carried by a native frame.
UFrameMetadata
Canonical semantic metadata of a native uProtocol frame.
UFrameMetadataBuilder
Builder for native frame metadata.

Enums§

FrameMessageKind
Semantic kind of a native uProtocol frame.
FramePriority
Semantic QoS class of a native uProtocol frame.
UFrameMetadataError
Errors returned by native frame metadata operations and projections.

Functions§

try_project_attributes_to_frame_metadata
Projects legacy UAttributes (plus an optional native payload encoding) into native frame metadata.
try_project_frame_to_umessage
Projects native frame metadata and optional payload bytes into a UMessage.
try_project_umessage_to_frame_metadata
Projects a UMessage into native frame metadata.