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

Module frame

Source
Expand description

The native frame data model: metadata, canonical field-block codec, and the read-side frame view contract.

§The UFrame data layer

Everything about frames-as-data lives here, independent of any transport:

  • metadataUFrameMetadata, the family-invariant semantic metadata model, plus PayloadEncoding identity and the fallible projections to and from UMessage attributes.
  • codec — the canonical metadata field-block profile: how metadata becomes bytes under a metadata profile.
  • envelope — complete-frame UPFE serialization, available with owned-frame-transport, for transports that carry metadata and payload in one byte envelope. Selected-wire UPWM profile prefixes are owned by the wire adapter, not this module.
  • abiUFrameMetadataAbiV1, the fixed-layout #[repr(C)] profile for cross-language shared-memory boundaries. NOTE: its consumers are C/C++ peers; zero Rust references is its expected steady state.

Spec: up-spec/basics/uframe.adoc and up-spec/up-l1/transport_families.adoc.

Re-exports§

pub use view::validate_frame_view_for_transport;
pub use view::UFrameView;

Modules§

abi
Fixed-layout ABI profile of native frame metadata, version 1.
codec
Canonical byte codec for native frame metadata: the UFrame metadata field block, version 1.
envelope
Whole-frame envelopes
metadata
Clean semantic native frame metadata.
view
Family-neutral frame views.