Struct UTxLoanSpec

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

Validated transport-independent transmit loan specification.

Implementations

impl UTxLoanSpec<Validated>

pub fn no_payload(metadata: UFrameMetadata) -> Result<Self, UStatus>

Creates a no-payload transmit loan spec.

Errors

Returns an error if the metadata is invalid or still carries payload encoding.

pub fn payload( metadata: UFrameMetadata, payload_len: usize, alignment: usize, ) -> Result<Self, UStatus>

Creates a present-payload transmit loan spec.

Errors

Returns an error if metadata is invalid, has no payload encoding, or if the requested payload alignment is invalid.

pub fn present_empty_payload(metadata: UFrameMetadata) -> Result<Self, UStatus>

Creates a present-empty-payload transmit loan spec.

Errors

Returns an error if the metadata is invalid or has no payload encoding.

impl UTxLoanSpec<Unvalidated>

pub fn new_unchecked(metadata: UFrameMetadata, payload: UTxPayloadSpec) -> Self

Creates a transmit loan spec without validation.

pub fn validate(self) -> Result<UTxLoanSpec<Validated>, UStatus>

Validates the spec, transitioning it to the Validated state.

Errors

Returns an error if metadata is invalid or if payload presence and payload encoding metadata disagree.

impl<S> UTxLoanSpec<S>

pub fn metadata(&self) -> &UFrameMetadata

Returns the immutable frame metadata associated with this loan.

pub fn into_metadata(self) -> UFrameMetadata

Consumes the spec and returns its metadata.

pub fn payload_spec(&self) -> UTxPayloadSpec

Returns the payload presence and layout spec.

pub fn has_payload(&self) -> bool

Returns whether the transmit frame carries a payload.

pub fn payload_len(&self) -> usize

Returns the visible application payload length.

pub fn payload_alignment(&self) -> usize

Returns the requested visible application payload alignment.

pub fn payload_alignment_proof(&self) -> PayloadAlignment

Returns the validated payload alignment proof.

Trait Implementations

impl<S: Clone> Clone for UTxLoanSpec<S>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for UTxLoanSpec<S>

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

Formats the value using the given formatter.

impl<S: PartialEq> PartialEq for UTxLoanSpec<S>

fn eq(&self, other: &UTxLoanSpec<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<S> StructuralPartialEq for UTxLoanSpec<S>