Struct UnalignedF64 

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

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

UnalignedF64 is guaranteed to have the same layout and bit validity as f64.

They are also guaranteed to have the same size.

Implementations

impl UnalignedF64

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

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

pub const fn get(self) -> f64

Returns the contained value as a primitive type.

pub fn swap_bytes(self) -> Self

Reverses the byte order of the float.

Examples

let n = UnalignedF64::new(1.0f64);
let m = n.swap_bytes();
// The result depends on the endianness of the target

pub 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 = UnalignedF64::new(1.0f64);

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

pub fn from_be(x: Self) -> Self

Converts a float 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 = UnalignedF64::new(1.0f64);

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

Trait Implementations

impl Add<f64> for UnalignedF64

type Output = f64

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for UnalignedF64

type Output = UnalignedF64

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for UnalignedF64

fn clone(&self) -> UnalignedF64

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnalignedF64

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

Formats the value using the given formatter.

impl Display for UnalignedF64

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

Formats the value using the given formatter.

impl Div<f64> for UnalignedF64

type Output = f64

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for UnalignedF64

type Output = UnalignedF64

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<UnalignedF64> for f64

fn from(value: UnalignedF64) -> Self

Converts to this type from the input type.

impl From<f64> for UnalignedF64

fn from(value: f64) -> Self

Converts to this type from the input type.

impl FromStr for UnalignedF64

type Err = <f64 as FromStr>::Err

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 Mul<f64> for UnalignedF64

type Output = f64

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for UnalignedF64

type Output = UnalignedF64

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq<f64> for UnalignedF64

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

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

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

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

type Output = f64

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for UnalignedF64

type Output = UnalignedF64

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for UnalignedF64

impl StructuralPartialEq for UnalignedF64