Struct UVecRxLease

pub struct UVecRxLease { /* private fields */ }

In-memory receive lease for tests and examples that need receive-lease shape.

Implementations

impl UVecRxLease

pub fn new( metadata: UFrameMetadata, payload: Option<Vec<u8>>, ) -> Result<Self, UStatus>

Creates an in-memory receive lease after validation.

Errors

Returns an error if metadata or payload presence is invalid.

pub fn new_unchecked(metadata: UFrameMetadata, payload: Option<Vec<u8>>) -> Self

Creates an in-memory receive lease without validation.

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

Consumes the lease and returns metadata plus optional payload bytes.

Trait Implementations

impl Clone for UVecRxLease

fn clone(&self) -> UVecRxLease

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UVecRxLease

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

Formats the value using the given formatter.

impl PartialEq for UVecRxLease

fn eq(&self, other: &UVecRxLease) -> 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 UVecRxLease

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 ULoanedContiguousZeroCopyRxFrame for UVecRxLease

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 StructuralPartialEq for UVecRxLease

impl UZeroCopyRxLease for UVecRxLease