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

Module wire

Source
Expand description

Selected-wire identities, payload codecs, and metadata profiles.

Wire authors define a UWire marker and stable WireIdentity, associate payload types through UWirePayload, and implement the codec traits the payload family requires. Physical carriage does not belong here. The adapter in wire_transport composes a wire and metadata codec over any compatible encoded core.

Receive checks identity before profile decoding. A mismatch is an explicit unknown-identity error, never fallback to another decoder (req~selected-wire-explicit-rejection~1). The conformance and golden tests under tests/wire_metadata_* plus external up-wire-xcdrv2-rust are the implementation references.

Structs§

NativePrefixFrameMetadataCodec
Canonical native-prefix metadata codec carrying the clean UFrame metadata field block.
ProtobufWire
Selected wire for Protocol Buffers application payloads.
StableContainerWireFormat
Selected wire for stable-container payloads.
UProtocolNativeWire
Default first-wave native wire for explicit native payload paths.
UWireMetadataContext
Selected-wire metadata context consumed by metadata codecs.
WireIdentity
Stable wire, payload-family, or metadata-layout identity.

Enums§

UWireMetadataError
Errors returned by native-prefix selected-wire metadata handling.
WireCompatibility
Compatibility decision between decoded metadata and a selected wire.
WireIdentityRef
Identity reference decoded from native-prefix metadata bytes.

Constants§

FORMAT_VERSION
First supported native-prefix metadata byte-format version.
INVALID_ID_FIXTURE_COMPACT_ID
Compact ID reserved for invalid-ID fixtures.
LOCAL_EXPERIMENTAL_COMPACT_ID_END
Last compact ID reserved for local or experimental future tools.
LOCAL_EXPERIMENTAL_COMPACT_ID_START
First compact ID reserved for local or experimental future tools.
NATIVE_EXPLICIT_PAYLOAD_FAMILY_ID
Payload-family identity for explicit native payload bytes.
NATIVE_PREFIX_METADATA_LAYOUT_ID
Identity for the first-wave native-prefix metadata layout.
PROTOBUF_PAYLOAD_FAMILY_ID
Payload-family identity for Protocol Buffers application payload bytes.
PROTOBUF_WIRE_ID
Identity for the first-wave Protocol Buffers selected wire.
STABLE_CONTAINER_PAYLOAD_FAMILY_ID
Payload-family identity for stable-container payloads.
STABLE_CONTAINER_WIRE_ID
Identity for the first-wave stable-container selected wire.
UFRAME_FIELDS_METADATA_LAYOUT_ID
Metadata layout identity for the canonical UFrame metadata field block carried behind native-prefix framing.
UPROTOCOL_NATIVE_WIRE_ID
Identity for the first-wave uProtocol native selected wire.
XCDR_V2_PAYLOAD_FAMILY_ID
Payload-family identity reserved for external XCDRv2 payload bytes.
XCDR_V2_WIRE_ID
Identity reserved for the external first-wave XCDRv2 selected wire.

Traits§

UWire
Static selected-wire contract.
UWireDecode
Wire-level borrowed decode helper alias for existing payload codecs.
UWireDecodeOwned
Wire-level owned decode helper alias for existing payload codecs.
UWireEncode
Wire-level encode helper alias for existing payload codecs.
UWireMetadataCodec
Explicit metadata codec used by selected-wire transport adapters.
UWireMetadataCodecFor
Metadata codec that is statically compatible with selected wire W.
UWirePayload
Selected-wire payload mapping for typed payloads.
UWireReadDecode
Wire-level reader decode helper alias for existing payload codecs.