Struct UnalignedI16 

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

A i16 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

UnalignedI16 is guaranteed to have the same layout and bit validity as i16.

They are also guaranteed to have the same size.

Implementations

impl UnalignedI16

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

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

pub const fn get(self) -> i16

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 = UnalignedI16::new(0x1234i16);
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 = UnalignedI16::new(0x1Ai16);

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 = UnalignedI16::new(0x1Ai16);

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

Trait Implementations

impl Add<i16> for UnalignedI16

type Output = i16

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for UnalignedI16

type Output = UnalignedI16

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for UnalignedI16

fn clone(&self) -> UnalignedI16

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnalignedI16

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

Formats the value using the given formatter.

impl Display for UnalignedI16

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

Formats the value using the given formatter.

impl Div<i16> for UnalignedI16

type Output = i16

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for UnalignedI16

type Output = UnalignedI16

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<UnalignedI16> for i16

fn from(value: UnalignedI16) -> Self

Converts to this type from the input type.

impl From<i16> for UnalignedI16

fn from(value: i16) -> Self

Converts to this type from the input type.

impl FromStr for UnalignedI16

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 UnalignedI16

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<i16> for UnalignedI16

type Output = i16

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for UnalignedI16

type Output = UnalignedI16

The resulting type after applying the * operator.

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

Performs the * operation.

impl Ord for UnalignedI16

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

fn eq(&self, other: &i16) -> 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 UnalignedI16

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

fn partial_cmp(&self, other: &i16) -> 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 UnalignedI16

fn partial_cmp(&self, other: &UnalignedI16) -> 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<i16> for UnalignedI16

type Output = i16

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for UnalignedI16

type Output = UnalignedI16

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for UnalignedI16

impl Eq for UnalignedI16

impl StructuralPartialEq for UnalignedI16