Struct UFrameMetadata

pub struct UFrameMetadata { /* private fields */ }

Canonical semantic metadata of a native uProtocol frame.

This is the model that owned frames (UOwnedFrame), zero-copy frame views, and selected-wire metadata codecs reason about. It owns its fields ergonomically (strings, options, Duration) because it is never reinterpreted as raw bytes across processes or languages; fixed-layout and byte-serialized representations are derived from it.

The frame’s payload presence is a property of the frame carrier (UOwnedFrame, UFrameView, TX loan specs), not of the metadata; the v1 invariant “payload present if and only if payload_encoding is present” is enforced at those boundaries.

Implementations

impl UFrameMetadata

pub fn publish(topic: UUri) -> UFrameMetadataBuilder

Starts building metadata for a publish frame on topic.

pub fn notification(origin: UUri, destination: UUri) -> UFrameMetadataBuilder

Starts building metadata for a notification frame from origin to destination.

pub fn request( method: UUri, reply_to: UUri, ttl: Duration, ) -> UFrameMetadataBuilder

Starts building metadata for an RPC request frame invoking method, with responses directed to reply_to.

Request frames require a TTL and default to FramePriority::CS4.

pub fn response( invoked_method: UUri, reply_to: UUri, request_id: UUID, ) -> UFrameMetadataBuilder

Starts building metadata for an RPC response frame from invoked_method to reply_to, correlated to the request with id request_id.

Response frames default to FramePriority::CS4.

pub fn kind(&self) -> FrameMessageKind

Returns the frame message kind.

pub fn id(&self) -> &UUID

Returns the unique frame id.

pub fn source(&self) -> &UUri

Returns the source address.

pub fn sink(&self) -> Option<&UUri>

Returns the sink address, if present.

pub fn reqid(&self) -> Option<&UUID>

Returns the correlated request id, if present.

pub fn priority(&self) -> Option<FramePriority>

Returns the frame priority, if present.

pub fn ttl(&self) -> Option<Duration>

Returns the time-to-live, if present.

pub fn comm_status(&self) -> Option<UCode>

Returns the communication status, if present.

pub fn permission_level(&self) -> Option<u32>

Returns the permission level, if present.

pub fn token(&self) -> Option<&str>

Returns the access token, if present.

pub fn traceparent(&self) -> Option<&str>

Returns the W3C traceparent, if present.

pub fn payload_encoding(&self) -> Option<&PayloadEncoding>

Returns the native payload encoding, if one is present.

pub fn into_payload_encoding(self) -> Option<PayloadEncoding>

Consumes this metadata and returns its native payload encoding.

pub fn with_payload_encoding( self, payload_encoding: PayloadEncoding, ) -> Result<Self, UFrameMetadataError>

Returns metadata equal to self but carrying payload_encoding.

Errors

Returns an error if the encoding or the resulting metadata is invalid.

pub fn without_payload_encoding(self) -> Self

Returns metadata equal to self but without a payload encoding.

pub fn validate(&self) -> Result<(), UFrameMetadataError>

Validates this metadata against the rules of its frame message kind.

Errors

Returns an error if the metadata violates the rules for its kind, for example a publish frame carrying a sink, a request frame without TTL, or an RPC frame with a priority below FramePriority::CS4.

pub fn try_project_to_attributes( &self, ) -> Result<UAttributes, UFrameMetadataError>

Projects this metadata to legacy UAttributes.

This is a compatibility projection for UTransport-family (UMessage-shaped) boundaries and is fallible by design only for fields that cannot be represented by legacy types, such as a TTL that does not fit the legacy 32-bit millisecond field. Open payload encodings are represented by the UAttributes payload-encoding identity fields.

Errors

Returns an error if the metadata is invalid or not representable.

Trait Implementations

impl Clone for UFrameMetadata

fn clone(&self) -> UFrameMetadata

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UFrameMetadata

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

Formats the value using the given formatter.

impl PartialEq for UFrameMetadata

fn eq(&self, other: &UFrameMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UFrameMetadata