Struct UOwnedFrame

pub struct UOwnedFrame<S = Validated> { /* private fields */ }

Owned, serialization-neutral native uProtocol frame.

UOwnedFrame carries Phase 01 frame metadata plus optional owned payload bytes. It is available only with the owned-frame-transport feature and is additive to the ordinary UTransport/UMessage compatibility path.

Implementations

impl UOwnedFrame<Validated>

pub fn new( metadata: UFrameMetadata, payload: Option<Bytes>, ) -> Result<Self, UFrameMetadataError>

Creates a frame from metadata and optional payload bytes after validation.

Errors

Returns an error if metadata validation fails or payload presence does not match metadata payload encoding presence.

pub fn new_unchecked( metadata: UFrameMetadata, payload: Option<Bytes>, ) -> UOwnedFrame<Unvalidated>

Creates a frame without validation.

pub fn with_payload( metadata: UFrameMetadata, payload: impl Into<Bytes>, ) -> Result<Self, UFrameMetadataError>

Creates a payload-bearing frame after validation.

Errors

Returns an error if metadata validation fails or the metadata has no payload encoding.

pub fn without_payload( metadata: UFrameMetadata, ) -> Result<Self, UFrameMetadataError>

Creates a no-payload frame after validation.

Errors

Returns an error if metadata validation fails or the metadata still has a payload encoding.

impl UOwnedFrame<Unvalidated>

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

Validates the frame, transitioning it to the Validated state.

This is the only way from Unvalidated to Validated; the state transition IS the validation, and every transport API accepts only the validated state.

Errors

Returns an error if metadata is invalid, if payload bytes are present without encoding metadata, or if encoding metadata is present without payload bytes.

impl UOwnedFrame<Validated>

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

Projects this frame into a UMessage — the compatibility bridge back to the UTransport family.

Errors

Returns an error if the frame metadata cannot be represented as message attributes.

impl<S> UOwnedFrame<S>

pub fn metadata(&self) -> &UFrameMetadata

Returns the frame metadata.

pub fn payload(&self) -> Option<&Bytes>

Returns the payload bytes when the frame carries a payload.

pub fn payload_bytes(&self) -> &[u8]

Returns the payload bytes, or an empty slice when payload is absent.

Use Self::payload when distinguishing absent payload from present empty payload matters.

pub fn has_payload(&self) -> bool

Returns whether the frame carries payload bytes, including present empty payloads.

pub fn into_metadata(self) -> UFrameMetadata

Consumes the frame and returns its metadata.

pub fn into_payload(self) -> Option<Bytes>

Consumes the frame and returns its optional payload bytes.

pub fn into_parts(self) -> (UFrameMetadata, Option<Bytes>)

Consumes the frame and returns metadata plus optional payload bytes.

Trait Implementations

impl<S: Clone> Clone for UOwnedFrame<S>

fn clone(&self) -> UOwnedFrame<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for UOwnedFrame<S>

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

Formats the value using the given formatter.

impl<S: PartialEq> PartialEq for UOwnedFrame<S>

fn eq(&self, other: &UOwnedFrame<S>) -> 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 UFrameView for UOwnedFrame

type PayloadReader<'a> = Cursor<&'a [u8]> where Self: 'a

Reader over the payload bytes in order.

type PayloadSlices<'a> = IntoIter<&'a [u8]> where Self: 'a

Iterator over the payload’s storage segments in order.

fn metadata(&self) -> &UFrameMetadata

Returns the native frame metadata.

fn payload_len(&self) -> usize

Returns the number of application payload bytes visible through this view.

fn has_payload(&self) -> bool

Returns whether this view carries a payload, including a present empty payload.

fn payload_reader(&self) -> Self::PayloadReader<'_>

Returns an ordered reader over the application payload bytes.

fn payload_slices(&self) -> Self::PayloadSlices<'_>

Returns ordered borrowed payload slices.

fn try_contiguous_payload(&self) -> Option<&[u8]>

Returns a contiguous borrowed payload view when this view can provide one without copying.

fn decode_payload_from_reader_as<C, T>(&self) -> Result<T, UWireError>

where C: PayloadCodec + ReadDecodePayload<T>,

Decodes this frame view from its ordered payload reader with codec C.

impl<S> StructuralPartialEq for UOwnedFrame<S>