Struct UnalignedU16 

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

A u16 that has an alignment requirement of 1 byte, i.e. is unaligned

This is useful in packed structures and slices of data contained in variable-length arrays in VPP messages.

Layout

UnalignedU16 is guaranteed to have the same layout and bit validity as u16.

They are also guaranteed to have the same size.

Implementations

impl UnalignedU16

pub const fn new(value: u16) -> Self

Creates a u16 that has an alignment requirement of 1 byte, i.e. is unaligned.

pub const fn get(self) -> u16

Returns the contained value as a primitive type.

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

Examples

let n = UnalignedU16::new(0x1234u16);
let m = n.swap_bytes();

assert_eq!(m, 0x3412);

pub const fn to_be(self) -> Self

Converts self to big endian from the target’s endianness.

On big endian this is a no-op. On little endian the bytes are swapped.

Examples

let n = UnalignedU16::new(0x1Au16);

if cfg!(target_endian = "big") {
    assert_eq!(n.to_be(), n)
} else {
    assert_eq!(n.to_be(), n.swap_bytes())
}

pub const fn from_be(x: Self) -> Self

Converts an integer from big endian to the target’s endianness.

On big endian this is a no-op. On little endian the bytes are swapped.

Examples

let n = UnalignedU16::new(0x1Au16);

if cfg!(target_endian = "big") {
    assert_eq!(UnalignedU16::from_be(n), n)
} else {
    assert_eq!(UnalignedU16::from_be(n), n.swap_bytes())
}

Trait Implementations

impl Add<u16> for UnalignedU16

type Output = u16

The resulting type after applying the + operator.

fn add(self, rhs: u16) -> u16

Performs the + operation.

impl Add for UnalignedU16

type Output = UnalignedU16

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl Clone for UnalignedU16

fn clone(&self) -> UnalignedU16

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnalignedU16

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

Formats the value using the given formatter.

impl Display for UnalignedU16

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

Formats the value using the given formatter.

impl Div<u16> for UnalignedU16

type Output = u16

The resulting type after applying the / operator.

fn div(self, rhs: u16) -> u16

Performs the / operation.

impl Div for UnalignedU16

type Output = UnalignedU16

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self

Performs the / operation.

impl From<UnalignedU16> for u16

fn from(value: UnalignedU16) -> Self

Converts to this type from the input type.

impl From<u16> for UnalignedU16

fn from(value: u16) -> Self

Converts to this type from the input type.

impl FromStr for UnalignedU16

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for UnalignedU16

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 Mul<u16> for UnalignedU16

type Output = u16

The resulting type after applying the * operator.

fn mul(self, rhs: u16) -> u16

Performs the * operation.

impl Mul for UnalignedU16

type Output = UnalignedU16

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self

Performs the * operation.

impl Ord for UnalignedU16

fn cmp(&self, other: &UnalignedU16) -> 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<u16> for UnalignedU16

fn eq(&self, other: &u16) -> 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 PartialEq for UnalignedU16

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

fn partial_cmp(&self, other: &u16) -> 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 PartialOrd for UnalignedU16

fn partial_cmp(&self, other: &UnalignedU16) -> 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 Sub<u16> for UnalignedU16

type Output = u16

The resulting type after applying the - operator.

fn sub(self, rhs: u16) -> u16

Performs the - operation.

impl Sub for UnalignedU16

type Output = UnalignedU16

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl Copy for UnalignedU16

impl Eq for UnalignedU16

impl StructuralPartialEq for UnalignedU16