Enum UTxPayloadSpec

pub enum UTxPayloadSpec {
    Absent,
    Present {
        len: usize,
        alignment: PayloadAlignment,
    },
}

Payload presence and layout requested for a transmit loan.

Variants

Absent

The frame carries no payload and no payload encoding metadata.

Present

The frame carries a payload, including a present empty payload.

Fields

len: usize

Payload length in bytes.

alignment: PayloadAlignment

Required payload alignment.

Implementations

impl UTxPayloadSpec

pub fn present(len: usize, alignment: usize) -> Result<Self, UStatus>

Creates a present-payload spec from length and alignment.

Errors

Returns an error if alignment is zero or not a power of two.

pub fn present_with_alignment(len: usize, alignment: PayloadAlignment) -> Self

Creates a present-payload spec from length and a validated alignment.

pub fn present_empty() -> Self

Creates a present-empty-payload spec.

pub fn is_present(self) -> bool

Returns whether this spec represents a present payload.

pub fn len(self) -> usize

Returns the visible application payload length.

pub fn is_empty(self) -> bool

Returns true if the visible application payload length is zero.

pub fn alignment(self) -> usize

Returns the requested visible application payload alignment.

pub fn payload_alignment(self) -> PayloadAlignment

Returns the validated payload alignment proof for this spec.

Trait Implementations

impl Clone for UTxPayloadSpec

fn clone(&self) -> UTxPayloadSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UTxPayloadSpec

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

Formats the value using the given formatter.

impl PartialEq for UTxPayloadSpec

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

impl Eq for UTxPayloadSpec

impl StructuralPartialEq for UTxPayloadSpec