Struct PayloadAlignment

pub struct PayloadAlignment(/* private fields */);

Validated visible application payload alignment in bytes.

The value is always nonzero and a power of two. Runtime values from config, metadata, or transport boundaries must be constructed with Self::new or TryFrom<usize> so those boundaries keep their explicit validation.

Implementations

impl PayloadAlignment

pub const ONE: Self

Alignment for absent payloads and byte-oriented payloads.

pub fn new(value: usize) -> Result<Self, UStatus>

Creates a payload alignment after validating the nonzero power-of-two invariant.

Errors

Returns an error when value is zero or not a power of two.

pub const fn as_usize(self) -> usize

Returns the raw alignment value in bytes.

Trait Implementations

impl Clone for PayloadAlignment

fn clone(&self) -> PayloadAlignment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PayloadAlignment

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

Formats the value using the given formatter.

impl Hash for PayloadAlignment

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PayloadAlignment

fn cmp(&self, other: &PayloadAlignment) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PayloadAlignment

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

fn partial_cmp(&self, other: &PayloadAlignment) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<usize> for PayloadAlignment

type Error = UStatus

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for PayloadAlignment

impl Eq for PayloadAlignment

impl StructuralPartialEq for PayloadAlignment