Struct WireF32

#[repr(C, align(4))]
pub struct WireF32(pub f32);

A wire-encoded f32

Tuple Fields

0: f32

Methods from Deref<Target = f32>

pub const RADIX: u32 = 2u32

pub const MANTISSA_DIGITS: u32 = 24u32

pub const DIGITS: u32 = 6u32

pub const EPSILON: f32 = 1.1920929E-7f32

pub const MIN: f32 = -3.40282347E+38f32

pub const MIN_POSITIVE: f32 = 1.17549435E-38f32

pub const MAX: f32 = 3.40282347E+38f32

pub const MIN_EXP: i32 = -125i32

pub const MAX_EXP: i32 = 128i32

pub const MIN_10_EXP: i32 = -37i32

pub const MAX_10_EXP: i32 = 38i32

pub const NAN: f32 = NaN_f32

pub const INFINITY: f32 = +Inf_f32

pub const NEG_INFINITY: f32 = -Inf_f32

pub fn total_cmp(&self, other: &f32) -> Ordering

Returns the ordering between self and other.

Unlike the standard partial comparison between floating point numbers, this comparison always produces an ordering in accordance to the totalOrder predicate as defined in the IEEE 754 (2008 revision) floating point standard. The values are ordered in the following sequence:

• negative quiet NaN
• negative signaling NaN
• negative infinity
• negative numbers
• negative subnormal numbers
• negative zero
• positive zero
• positive subnormal numbers
• positive numbers
• positive infinity
• positive signaling NaN
• positive quiet NaN.

The ordering established by this function does not always agree with the PartialOrd and PartialEq implementations of f32. For example, they consider negative and positive zero equal, while total_cmp doesn’t.

The interpretation of the signaling NaN bit follows the definition in the IEEE 754 standard, which may not match the interpretation by some of the older, non-conformant (e.g. MIPS) hardware implementations.

Example

struct GoodBoy {
    name: String,
    weight: f32,
}

let mut bois = vec![
    GoodBoy { name: "Pucci".to_owned(), weight: 0.1 },
    GoodBoy { name: "Woofer".to_owned(), weight: 99.0 },
    GoodBoy { name: "Yapper".to_owned(), weight: 10.0 },
    GoodBoy { name: "Chonk".to_owned(), weight: f32::INFINITY },
    GoodBoy { name: "Abs. Unit".to_owned(), weight: f32::NAN },
    GoodBoy { name: "Floaty".to_owned(), weight: -5.0 },
];

bois.sort_by(|a, b| a.weight.total_cmp(&b.weight));

// `f32::NAN` could be positive or negative, which will affect the sort order.
if f32::NAN.is_sign_negative() {
    assert!(bois.into_iter().map(|b| b.weight)
        .zip([f32::NAN, -5.0, 0.1, 10.0, 99.0, f32::INFINITY].iter())
        .all(|(a, b)| a.to_bits() == b.to_bits()))
} else {
    assert!(bois.into_iter().map(|b| b.weight)
        .zip([-5.0, 0.1, 10.0, 99.0, f32::INFINITY, f32::NAN].iter())
        .all(|(a, b)| a.to_bits() == b.to_bits()))
}

Trait Implementations

impl Add<&WireF32> for &WireF32

type Output = f32

The resulting type after applying the + operator.

fn add(self, other: &WireF32) -> Self::Output

Performs the + operation.

impl Add<&WireF32> for &f32

type Output = f32

The resulting type after applying the + operator.

fn add(self, other: &WireF32) -> Self::Output

Performs the + operation.

impl Add<&WireF32> for WireF32

type Output = f32

The resulting type after applying the + operator.

fn add(self, other: &WireF32) -> Self::Output

Performs the + operation.

impl Add<&WireF32> for f32

type Output = f32

The resulting type after applying the + operator.

fn add(self, other: &WireF32) -> Self::Output

Performs the + operation.

impl Add<&f32> for &WireF32

type Output = f32

The resulting type after applying the + operator.

fn add(self, other: &f32) -> Self::Output

Performs the + operation.

impl Add<&f32> for WireF32

type Output = f32

The resulting type after applying the + operator.

fn add(self, other: &f32) -> Self::Output

Performs the + operation.

impl Add<WireF32> for &WireF32

type Output = f32

The resulting type after applying the + operator.

fn add(self, other: WireF32) -> Self::Output

Performs the + operation.

impl Add<WireF32> for &f32

type Output = f32

The resulting type after applying the + operator.

fn add(self, other: WireF32) -> Self::Output

Performs the + operation.

impl Add<WireF32> for f32

type Output = f32

The resulting type after applying the + operator.

fn add(self, other: WireF32) -> Self::Output

Performs the + operation.

impl Add<f32> for &WireF32

type Output = f32

The resulting type after applying the + operator.

fn add(self, other: f32) -> Self::Output

Performs the + operation.

impl Add<f32> for WireF32

type Output = f32

The resulting type after applying the + operator.

fn add(self, other: f32) -> Self::Output

Performs the + operation.

impl Add for WireF32

type Output = f32

The resulting type after applying the + operator.

fn add(self, other: WireF32) -> Self::Output

Performs the + operation.

impl AddAssign<&WireF32> for WireF32

fn add_assign(&mut self, other: &WireF32)

Performs the += operation.

impl AddAssign<&f32> for WireF32

fn add_assign(&mut self, other: &f32)

Performs the += operation.

impl AddAssign<f32> for WireF32

fn add_assign(&mut self, other: f32)

Performs the += operation.

impl AddAssign for WireF32

fn add_assign(&mut self, other: WireF32)

Performs the += operation.

impl Clone for WireF32

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WireF32

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

Formats the value using the given formatter.

impl<D: ?Sized> Decode<D> for WireF32

fn decode(_: Slot<'_, Self>, _: &mut D) -> Result<(), DecodeError>

Decodes a value into a slot using a decoder.

impl Default for WireF32

fn default() -> Self

Returns the “default value” for a type.

impl Deref for WireF32

type Target = f32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for WireF32

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for WireF32

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

Formats the value using the given formatter.

impl Div<&WireF32> for &WireF32

type Output = f32

The resulting type after applying the / operator.

fn div(self, other: &WireF32) -> Self::Output

Performs the / operation.

impl Div<&WireF32> for &f32

type Output = f32

The resulting type after applying the / operator.

fn div(self, other: &WireF32) -> Self::Output

Performs the / operation.

impl Div<&WireF32> for WireF32

type Output = f32

The resulting type after applying the / operator.

fn div(self, other: &WireF32) -> Self::Output

Performs the / operation.

impl Div<&WireF32> for f32

type Output = f32

The resulting type after applying the / operator.

fn div(self, other: &WireF32) -> Self::Output

Performs the / operation.

impl Div<&f32> for &WireF32

type Output = f32

The resulting type after applying the / operator.

fn div(self, other: &f32) -> Self::Output

Performs the / operation.

impl Div<&f32> for WireF32

type Output = f32

The resulting type after applying the / operator.

fn div(self, other: &f32) -> Self::Output

Performs the / operation.

impl Div<WireF32> for &WireF32

type Output = f32

The resulting type after applying the / operator.

fn div(self, other: WireF32) -> Self::Output

Performs the / operation.

impl Div<WireF32> for &f32

type Output = f32

The resulting type after applying the / operator.

fn div(self, other: WireF32) -> Self::Output

Performs the / operation.

impl Div<WireF32> for f32

type Output = f32

The resulting type after applying the / operator.

fn div(self, other: WireF32) -> Self::Output

Performs the / operation.

impl Div<f32> for &WireF32

type Output = f32

The resulting type after applying the / operator.

fn div(self, other: f32) -> Self::Output

Performs the / operation.

impl Div<f32> for WireF32

type Output = f32

The resulting type after applying the / operator.

fn div(self, other: f32) -> Self::Output

Performs the / operation.

impl Div for WireF32

type Output = f32

The resulting type after applying the / operator.

fn div(self, other: WireF32) -> Self::Output

Performs the / operation.

impl DivAssign<&WireF32> for WireF32

fn div_assign(&mut self, other: &WireF32)

Performs the /= operation.

impl DivAssign<&f32> for WireF32

fn div_assign(&mut self, other: &f32)

Performs the /= operation.

impl DivAssign<f32> for WireF32

fn div_assign(&mut self, other: f32)

Performs the /= operation.

impl DivAssign for WireF32

fn div_assign(&mut self, other: WireF32)

Performs the /= operation.

impl Encodable for WireF32

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly during encoding instead of calling encode.

type Encoded = WireF32

The wire type for the value.

impl EncodableOption for WireF32

type EncodedOption = WireBox<WireF32>

The wire type for the optional value.

impl<E: ?Sized> Encode<E> for WireF32

fn encode( &mut self, _: &mut E, slot: Slot<'_, Self::Encoded>, ) -> Result<(), EncodeError>

Encodes this value into an encoder and slot.

impl<E: Encoder + ?Sized> EncodeOption<E> for WireF32

fn encode_option( this: Option<&mut Self>, encoder: &mut E, slot: Slot<'_, Self::EncodedOption>, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and slot.

impl<'a> From<&'a WireF32> for f32

fn from(value: &'a WireF32) -> Self

Converts to this type from the input type.

impl<'a> From<&'a f32> for WireF32

fn from(value: &'a f32) -> Self

Converts to this type from the input type.

impl From<WireF32> for f32

fn from(value: WireF32) -> Self

Converts to this type from the input type.

impl From<f32> for WireF32

fn from(value: f32) -> Self

Converts to this type from the input type.

impl FromBytes for WireF32

where f32: FromBytes,

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl FromZeros for WireF32

where f32: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl IntoBytes for WireF32

where f32: IntoBytes, (): PaddingFree<Self, { _ }>,

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

impl LowerExp for WireF32

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

Formats the value using the given formatter.

impl Mul<&WireF32> for &WireF32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, other: &WireF32) -> Self::Output

Performs the * operation.

impl Mul<&WireF32> for &f32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, other: &WireF32) -> Self::Output

Performs the * operation.

impl Mul<&WireF32> for WireF32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, other: &WireF32) -> Self::Output

Performs the * operation.

impl Mul<&WireF32> for f32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, other: &WireF32) -> Self::Output

Performs the * operation.

impl Mul<&f32> for &WireF32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, other: &f32) -> Self::Output

Performs the * operation.

impl Mul<&f32> for WireF32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, other: &f32) -> Self::Output

Performs the * operation.

impl Mul<WireF32> for &WireF32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, other: WireF32) -> Self::Output

Performs the * operation.

impl Mul<WireF32> for &f32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, other: WireF32) -> Self::Output

Performs the * operation.

impl Mul<WireF32> for f32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, other: WireF32) -> Self::Output

Performs the * operation.

impl Mul<f32> for &WireF32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, other: f32) -> Self::Output

Performs the * operation.

impl Mul<f32> for WireF32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, other: f32) -> Self::Output

Performs the * operation.

impl Mul for WireF32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, other: WireF32) -> Self::Output

Performs the * operation.

impl MulAssign<&WireF32> for WireF32

fn mul_assign(&mut self, other: &WireF32)

Performs the *= operation.

impl MulAssign<&f32> for WireF32

fn mul_assign(&mut self, other: &f32)

Performs the *= operation.

impl MulAssign<f32> for WireF32

fn mul_assign(&mut self, other: f32)

Performs the *= operation.

impl MulAssign for WireF32

fn mul_assign(&mut self, other: WireF32)

Performs the *= operation.

impl Neg for WireF32

type Output = <f32 as Neg>::Output

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq<WireF32> for f32

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

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

fn eq(&self, other: &Self) -> 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<f32> for WireF32

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

fn partial_cmp(&self, other: &Self) -> 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 Product for WireF32

fn product<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl Rem<&WireF32> for &WireF32

type Output = f32

The resulting type after applying the % operator.

fn rem(self, other: &WireF32) -> Self::Output

Performs the % operation.

impl Rem<&WireF32> for &f32

type Output = f32

The resulting type after applying the % operator.

fn rem(self, other: &WireF32) -> Self::Output

Performs the % operation.

impl Rem<&WireF32> for WireF32

type Output = f32

The resulting type after applying the % operator.

fn rem(self, other: &WireF32) -> Self::Output

Performs the % operation.

impl Rem<&WireF32> for f32

type Output = f32

The resulting type after applying the % operator.

fn rem(self, other: &WireF32) -> Self::Output

Performs the % operation.

impl Rem<&f32> for &WireF32

type Output = f32

The resulting type after applying the % operator.

fn rem(self, other: &f32) -> Self::Output

Performs the % operation.

impl Rem<&f32> for WireF32

type Output = f32

The resulting type after applying the % operator.

fn rem(self, other: &f32) -> Self::Output

Performs the % operation.

impl Rem<WireF32> for &WireF32

type Output = f32

The resulting type after applying the % operator.

fn rem(self, other: WireF32) -> Self::Output

Performs the % operation.

impl Rem<WireF32> for &f32

type Output = f32

The resulting type after applying the % operator.

fn rem(self, other: WireF32) -> Self::Output

Performs the % operation.

impl Rem<WireF32> for f32

type Output = f32

The resulting type after applying the % operator.

fn rem(self, other: WireF32) -> Self::Output

Performs the % operation.

impl Rem<f32> for &WireF32

type Output = f32

The resulting type after applying the % operator.

fn rem(self, other: f32) -> Self::Output

Performs the % operation.

impl Rem<f32> for WireF32

type Output = f32

The resulting type after applying the % operator.

fn rem(self, other: f32) -> Self::Output

Performs the % operation.

impl Rem for WireF32

type Output = f32

The resulting type after applying the % operator.

fn rem(self, other: WireF32) -> Self::Output

Performs the % operation.

impl RemAssign<&WireF32> for WireF32

fn rem_assign(&mut self, other: &WireF32)

Performs the %= operation.

impl RemAssign<&f32> for WireF32

fn rem_assign(&mut self, other: &f32)

Performs the %= operation.

impl RemAssign<f32> for WireF32

fn rem_assign(&mut self, other: f32)

Performs the %= operation.

impl RemAssign for WireF32

fn rem_assign(&mut self, other: WireF32)

Performs the %= operation.

impl Sub<&WireF32> for &WireF32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, other: &WireF32) -> Self::Output

Performs the - operation.

impl Sub<&WireF32> for &f32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, other: &WireF32) -> Self::Output

Performs the - operation.

impl Sub<&WireF32> for WireF32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, other: &WireF32) -> Self::Output

Performs the - operation.

impl Sub<&WireF32> for f32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, other: &WireF32) -> Self::Output

Performs the - operation.

impl Sub<&f32> for &WireF32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, other: &f32) -> Self::Output

Performs the - operation.

impl Sub<&f32> for WireF32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, other: &f32) -> Self::Output

Performs the - operation.

impl Sub<WireF32> for &WireF32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, other: WireF32) -> Self::Output

Performs the - operation.

impl Sub<WireF32> for &f32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, other: WireF32) -> Self::Output

Performs the - operation.

impl Sub<WireF32> for f32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, other: WireF32) -> Self::Output

Performs the - operation.

impl Sub<f32> for &WireF32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, other: f32) -> Self::Output

Performs the - operation.

impl Sub<f32> for WireF32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, other: f32) -> Self::Output

Performs the - operation.

impl Sub for WireF32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, other: WireF32) -> Self::Output

Performs the - operation.

impl SubAssign<&WireF32> for WireF32

fn sub_assign(&mut self, other: &WireF32)

Performs the -= operation.

impl SubAssign<&f32> for WireF32

fn sub_assign(&mut self, other: &f32)

Performs the -= operation.

impl SubAssign<f32> for WireF32

fn sub_assign(&mut self, other: f32)

Performs the -= operation.

impl SubAssign for WireF32

fn sub_assign(&mut self, other: WireF32)

Performs the -= operation.

impl Sum for WireF32

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TakeFrom<WireF32> for WireF32

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly during conversion instead of calling take_from.

fn take_from(from: &WireF32) -> WireF32

Converts from the given T, taking any resources that can’t be cloned.

impl TakeFrom<WireF32> for f32

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly during conversion instead of calling take_from.

fn take_from(from: &WireF32) -> f32

Converts from the given T, taking any resources that can’t be cloned.

impl TryFromBytes for WireF32

where f32: TryFromBytes,

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl UpperExp for WireF32

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

Formats the value using the given formatter.

impl ZeroPadding for WireF32

unsafe fn zero_padding(_: *mut Self)

Writes zeroes to the padding for this type, if any.

impl Copy for WireF32

impl Eq for WireF32