Struct UWireRx

pub struct UWireRx<Rx, W, C>
where
    W: UWire,
{ /* private fields */ }

Public zero-copy receive lease after selected-wire metadata validation.

Implementations

impl<Rx, W, C> UWireRx<Rx, W, C>

where Rx: UEncodedRxFrame, W: UWire, C: UWireMetadataCodecFor<W>,

pub fn try_from_encoded(raw: Rx, codec: &C) -> Result<Self, UStatus>

Decodes metadata from a raw encoded receive object and validates the public frame view.

Errors

Returns an error if metadata bytes are malformed, selected-wire checks fail, or the resulting public frame view violates transport invariants.

pub fn raw(&self) -> &Rx

Returns the raw encoded receive object behind this public wrapper.

pub fn into_raw(self) -> Rx

Consumes the public wrapper and returns the raw encoded receive object.

pub fn decode_payload<T>(&self) -> Result<T, UWireError>

where W: UWirePayload<T>, <W as UWirePayload<T>>::Codec: ReadDecodePayload<T>,

Decodes this frame’s payload using the selected wire W.

Prefer this selected-wire helper on receive values produced by explicit selected-wire adapter construction. Use UFrameView::decode_payload_from_reader_as only for low-level codec escape hatches.

Errors

Returns an error if the frame has missing or incompatible payload encoding, has no payload, or if the selected wire cannot decode the payload bytes.

impl<Rx, W, C> UWireRx<Rx, W, C>

where Rx: UEncodedLoanedRxFrame, W: UWire, C: UWireMetadataCodecFor<W>,

pub fn borrow_payload<T>(&self) -> Result<&T, UWireError>

where W: UWirePayload<T>, <W as UWirePayload<T>>::Codec: BorrowPayload<T>,

Borrows this frame’s payload using the selected wire’s payload mapping.

This is the selected-wire true zero-copy receive helper. It requires the raw receive frame to prove that the contiguous payload is loan-backed and requires the selected wire’s mapped codec to support typed borrowing.

Errors

Returns an error if the frame has no payload, has missing or incompatible payload encoding, cannot expose one loan-backed contiguous payload, or if the selected codec cannot borrow T from those bytes.

Trait Implementations

impl<Rx, W, C> Debug for UWireRx<Rx, W, C>

where W: UWire,

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

Formats the value using the given formatter.

impl<Rx, W, C> UFrameView for UWireRx<Rx, W, C>

where Rx: UEncodedRxFrame, W: UWire, C: UWireMetadataCodecFor<W>,

type PayloadReader<'a> = <Rx as UEncodedRxFrame>::PayloadReader<'a> where Self: 'a

Reader over the payload bytes in order.

type PayloadSlices<'a> = <Rx as UEncodedRxFrame>::PayloadSlices<'a> 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<Rx, W, C> ULoanedContiguousZeroCopyRxFrame for UWireRx<Rx, W, C>

where Rx: UEncodedLoanedRxFrame, W: UWire, C: UWireMetadataCodecFor<W>,

fn loaned_contiguous_payload(&self) -> Result<LoanedPayload<'_>, UWireError>

Returns one contiguous loan-backed application payload view.

fn payload_loan_provenance(&self) -> Result<PayloadLoanProvenance, UWireError>

Returns diagnostic provenance for successful loaned payload borrows.

fn try_loaned_contiguous_payload(&self) -> Result<&[u8], UWireError>

Returns only loan-backed contiguous payload bytes.

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

where T: StablePayload,

Borrows one stable-container value from loan-backed contiguous storage.

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

where C: BorrowPayload<T>,

Borrows one typed value from loan-backed contiguous storage using codec C.

impl<Rx, W, C> UZeroCopyRxLease for UWireRx<Rx, W, C>

where Rx: UEncodedRxFrame, W: UWire, C: UWireMetadataCodecFor<W>,