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

Struct PreparedTxLoanSpec

Source
pub struct PreparedTxLoanSpec { /* private fields */ }
Expand description

Prepared zero-copy transmit request passed from the adapter to a core.

Implementations§

Source§

impl PreparedTxLoanSpec

Source

pub fn from_validated<W, C>( spec: UTxLoanSpec, codec: &C, ) -> Result<Self, UStatus>
where W: UWire, C: UWireMetadataCodecFor<W>,

Encodes validated metadata for a selected wire.

§Errors

Returns an error if selected-wire metadata encoding fails.

Source

pub fn from_encoded_parts( metadata: UFrameMetadata, encoded_metadata: impl Into<Vec<u8>>, payload_len: usize, payload_alignment: usize, ) -> Result<Self, UStatus>

Creates a prepared loan spec from metadata bytes that are already encoded for the selected wire associated with metadata.

This is an advanced adapter/core boundary helper for owned-loopback bridges. Callers must pass encoded_metadata produced by the same selected wire that will decode metadata on receive; this constructor validates the decoded metadata and payload layout but cannot prove that the opaque metadata bytes were produced by a particular wire.

§Errors

Returns an error if metadata, payload presence, or payload alignment is invalid for a zero-copy transmit loan.

Source

pub fn metadata(&self) -> &UFrameMetadata

Returns the decoded frame metadata used to prepare this request.

Source

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

Returns selected-wire encoded metadata bytes.

Source

pub fn payload_len(&self) -> usize

Returns the visible application payload length requested from the core.

Source

pub fn payload_alignment(&self) -> usize

Returns the visible application payload alignment requested from the core.

Source

pub fn payload_alignment_proof(&self) -> PayloadAlignment

Returns the validated visible application payload alignment proof.

Source

pub fn has_payload(&self) -> bool

Returns whether the request carries a payload, including a present empty payload.

Source

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

Consumes this request and returns its parts.

Trait Implementations§

Source§

impl Clone for PreparedTxLoanSpec

Source§

fn clone(&self) -> PreparedTxLoanSpec

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PreparedTxLoanSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for PreparedTxLoanSpec

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for PreparedTxLoanSpec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Any for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<TCore> UWithNativePrefixWire for TCore

Source§

fn into_native_prefix_wire_transport<W>( self, wire: W, ) -> UWireTransport<TCore, W, NativePrefixFrameMetadataCodec>
where W: UWire,

Wraps this core with an external or custom selected wire using canonical metadata.
Source§

fn into_protobuf_transport( self, ) -> UWireTransport<TCore, ProtobufWire, NativePrefixFrameMetadataCodec>

Wraps this core with the Protocol Buffers selected-wire profile.
Source§

fn into_stable_container_transport( self, ) -> UWireTransport<TCore, StableContainerWireFormat, NativePrefixFrameMetadataCodec>

Wraps this core with the stable-container selected-wire profile.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more