Struct F32

pub struct F32<O>(/* private fields */);

A 32-bit floating point number stored in a given byte order.

F32 is like the native f32 type with two major differences: First, it has no alignment requirement (its alignment is 1). Second, the endianness of its memory layout is given by the type parameter O, which can be any type which implements ByteOrder. In particular, this refers to BigEndian, LittleEndian, NativeEndian, and NetworkEndian.

An F32 can be constructed using the new method, and its contained value can be obtained as a native f32 using the get method, or updated in place with the set method. In all cases, if the endianness O is not the same as the endianness of the current platform, an endianness swap will be performed in order to uphold the invariants that a) the layout of F32 has endianness O and that, b) the layout of f32 has the platform’s native endianness.

F32 implements FromBytes, IntoBytes, and Unaligned, making it useful for parsing and serialization. See the module documentation for an example of how it can be used for parsing UDP packets.

Implementations

impl<O> F32<O>

pub const ZERO: F32<O> = _

The value zero.

This constant should be preferred to constructing a new value using new, as new may perform an endianness swap depending on the endianness and platform.

pub const fn from_bytes(bytes: [u8; 4]) -> F32<O>

Constructs a new value from bytes which are already in O byte order.

pub const fn to_bytes(self) -> [u8; 4]

Extracts the bytes of self without swapping the byte order.

The returned bytes will be in O byte order.

impl<O: ByteOrder> F32<O>

pub const fn new(n: f32) -> F32<O>

Constructs a new value, possibly performing an endianness swap to guarantee that the returned value has endianness O.

pub const fn get(self) -> f32

Returns the value as a primitive type, possibly performing an endianness swap to guarantee that the return value has the endianness of the native platform.

pub fn set(&mut self, n: f32)

Updates the value in place as a primitive type, possibly performing an endianness swap to guarantee that the stored value has the endianness O.

Trait Implementations

impl<O: ByteOrder> Add<F32<O>> for f32

type Output = F32<O>

The resulting type after applying the + operator.

fn add(self, rhs: F32<O>) -> F32<O>

Performs the + operation.

impl<O: ByteOrder> Add<f32> for F32<O>

type Output = F32<O>

The resulting type after applying the + operator.

fn add(self, rhs: f32) -> F32<O>

Performs the + operation.

impl<O: ByteOrder> Add for F32<O>

type Output = F32<O>

The resulting type after applying the + operator.

fn add(self, rhs: F32<O>) -> F32<O>

Performs the + operation.

impl<O: ByteOrder> AddAssign<F32<O>> for f32

fn add_assign(&mut self, rhs: F32<O>)

Performs the += operation.

impl<O: ByteOrder> AddAssign<f32> for F32<O>

fn add_assign(&mut self, rhs: f32)

Performs the += operation.

impl<O: ByteOrder> AddAssign for F32<O>

fn add_assign(&mut self, rhs: F32<O>)

Performs the += operation.

impl<O> AsMut<[u8; 4]> for F32<O>

fn as_mut(&mut self) -> &mut [u8; 4]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<O> AsRef<[u8; 4]> for F32<O>

fn as_ref(&self) -> &[u8; 4]

Converts this type into a shared reference of the (usually inferred) input type.

impl<O: Clone> Clone for F32<O>

fn clone(&self) -> F32<O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: ByteOrder> Debug for F32<O>

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

Formats the value using the given formatter.

impl<O> Default for F32<O>

fn default() -> F32<O>

Returns the “default value” for a type.

impl<O: ByteOrder> Display for F32<O>

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

Formats the value using the given formatter.

impl<O: ByteOrder> Div<F32<O>> for f32

type Output = F32<O>

The resulting type after applying the / operator.

fn div(self, rhs: F32<O>) -> F32<O>

Performs the / operation.

impl<O: ByteOrder> Div<f32> for F32<O>

type Output = F32<O>

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> F32<O>

Performs the / operation.

impl<O: ByteOrder> Div for F32<O>

type Output = F32<O>

The resulting type after applying the / operator.

fn div(self, rhs: F32<O>) -> F32<O>

Performs the / operation.

impl<O: ByteOrder> DivAssign<F32<O>> for f32

fn div_assign(&mut self, rhs: F32<O>)

Performs the /= operation.

impl<O: ByteOrder> DivAssign<f32> for F32<O>

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl<O: ByteOrder> DivAssign for F32<O>

fn div_assign(&mut self, rhs: F32<O>)

Performs the /= operation.

impl<O: ByteOrder> From<[u8; 4]> for F32<O>

fn from(bytes: [u8; 4]) -> F32<O>

Converts to this type from the input type.

impl<O: ByteOrder> From<F32<O>> for [u8; 4]

fn from(x: F32<O>) -> [u8; 4]

Converts to this type from the input type.

impl<O: ByteOrder, P: ByteOrder> From<F32<O>> for F64<P>

fn from(x: F32<O>) -> F64<P>

Converts to this type from the input type.

impl<O: ByteOrder> From<F32<O>> for f32

fn from(x: F32<O>) -> f32

Converts to this type from the input type.

impl<O: ByteOrder> From<F32<O>> for f64

fn from(x: F32<O>) -> f64

Converts to this type from the input type.

impl<O: ByteOrder> From<f32> for F32<O>

fn from(x: f32) -> F32<O>

Converts to this type from the input type.

impl<O> FromBytes for F32<O>

where [u8; 4]: FromBytes, PhantomData<O>: FromBytes,

fn ref_from_bytes(source: &[u8]) -> Result<&Self, CastError<&[u8], Self>>

where Self: KnownLayout + Immutable,

Interprets the given source as a &Self.

fn ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), CastError<&[u8], Self>>

where Self: KnownLayout + Immutable,

Interprets the prefix of the given source as a &Self without copying.

fn ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), CastError<&[u8], Self>>

where Self: Immutable + KnownLayout,

Interprets the suffix of the given bytes as a &Self.

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, CastError<&mut [u8], Self>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), CastError<&mut [u8], Self>>

where Self: IntoBytes + KnownLayout,

Interprets the prefix of the given source as a &mut Self without copying.

fn mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), CastError<&mut [u8], Self>>

where Self: IntoBytes + KnownLayout,

Interprets the suffix of the given source as a &mut Self without copying.

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<O> FromZeros for F32<O>

where [u8; 4]: FromZeros, PhantomData<O>: 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<O: Hash> Hash for F32<O>

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<O> IntoBytes for F32<O>

where [u8; 4]: IntoBytes, PhantomData<O>: IntoBytes,

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

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

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl<O> KnownLayout for F32<O>

where Self: Sized,

type PointerMetadata = ()

The type of metadata stored in a pointer to Self.

impl<O: ByteOrder> Mul<F32<O>> for f32

type Output = F32<O>

The resulting type after applying the * operator.

fn mul(self, rhs: F32<O>) -> F32<O>

Performs the * operation.

impl<O: ByteOrder> Mul<f32> for F32<O>

type Output = F32<O>

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> F32<O>

Performs the * operation.

impl<O: ByteOrder> Mul for F32<O>

type Output = F32<O>

The resulting type after applying the * operator.

fn mul(self, rhs: F32<O>) -> F32<O>

Performs the * operation.

impl<O: ByteOrder> MulAssign<F32<O>> for f32

fn mul_assign(&mut self, rhs: F32<O>)

Performs the *= operation.

impl<O: ByteOrder> MulAssign<f32> for F32<O>

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl<O: ByteOrder> MulAssign for F32<O>

fn mul_assign(&mut self, rhs: F32<O>)

Performs the *= operation.

impl<O: ByteOrder> Neg for F32<O>

type Output = F32<O>

The resulting type after applying the - operator.

fn neg(self) -> F32<O>

Performs the unary - operation.

impl<O> PartialEq<[u8; 4]> for F32<O>

fn eq(&self, other: &[u8; 4]) -> 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<O> PartialEq<F32<O>> for [u8; 4]

fn eq(&self, other: &F32<O>) -> 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<O: ByteOrder> PartialEq<f32> for F32<O>

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<O: PartialEq> PartialEq for F32<O>

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

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<O: ByteOrder> Rem<F32<O>> for f32

type Output = F32<O>

The resulting type after applying the % operator.

fn rem(self, rhs: F32<O>) -> F32<O>

Performs the % operation.

impl<O: ByteOrder> Rem<f32> for F32<O>

type Output = F32<O>

The resulting type after applying the % operator.

fn rem(self, rhs: f32) -> F32<O>

Performs the % operation.

impl<O: ByteOrder> Rem for F32<O>

type Output = F32<O>

The resulting type after applying the % operator.

fn rem(self, rhs: F32<O>) -> F32<O>

Performs the % operation.

impl<O: ByteOrder> RemAssign<F32<O>> for f32

fn rem_assign(&mut self, rhs: F32<O>)

Performs the %= operation.

impl<O: ByteOrder> RemAssign<f32> for F32<O>

fn rem_assign(&mut self, rhs: f32)

Performs the %= operation.

impl<O: ByteOrder> RemAssign for F32<O>

fn rem_assign(&mut self, rhs: F32<O>)

Performs the %= operation.

impl<O: ByteOrder> Sub<F32<O>> for f32

type Output = F32<O>

The resulting type after applying the - operator.

fn sub(self, rhs: F32<O>) -> F32<O>

Performs the - operation.

impl<O: ByteOrder> Sub<f32> for F32<O>

type Output = F32<O>

The resulting type after applying the - operator.

fn sub(self, rhs: f32) -> F32<O>

Performs the - operation.

impl<O: ByteOrder> Sub for F32<O>

type Output = F32<O>

The resulting type after applying the - operator.

fn sub(self, rhs: F32<O>) -> F32<O>

Performs the - operation.

impl<O: ByteOrder> SubAssign<F32<O>> for f32

fn sub_assign(&mut self, rhs: F32<O>)

Performs the -= operation.

impl<O: ByteOrder> SubAssign<f32> for F32<O>

fn sub_assign(&mut self, rhs: f32)

Performs the -= operation.

impl<O: ByteOrder> SubAssign for F32<O>

fn sub_assign(&mut self, rhs: F32<O>)

Performs the -= operation.

impl<O> TryFromBytes for F32<O>

where [u8; 4]: TryFromBytes, PhantomData<O>: TryFromBytes,

fn try_ref_from_bytes(source: &[u8]) -> Result<&Self, TryCastError<&[u8], Self>>

where Self: KnownLayout + Immutable,

Attempts to interpret the given source as a &Self.

fn try_ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), TryCastError<&[u8], Self>>

where Self: KnownLayout + Immutable,

Attempts to interpret the prefix of the given source as a &Self.

fn try_ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), TryCastError<&[u8], Self>>

where Self: KnownLayout + Immutable,

Attempts to interpret the suffix of the given source as a &Self.

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, TryCastError<&mut [u8], Self>>

where Self: KnownLayout,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), TryCastError<&mut [u8], Self>>

where Self: KnownLayout,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), TryCastError<&mut [u8], Self>>

where Self: KnownLayout,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_read_from_bytes(source: &[u8]) -> Result<Self, TryReadError<&[u8], Self>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), TryReadError<&[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), TryReadError<&[u8], Self>>

where Self: Sized,

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

impl<O: Copy> Copy for F32<O>

impl<O: Eq> Eq for F32<O>

impl<O> Immutable for F32<O>

where [u8; 4]: Immutable, PhantomData<O>: Immutable,

impl<O> StructuralPartialEq for F32<O>

impl<O> Unaligned for F32<O>

where [u8; 4]: Unaligned, PhantomData<O>: Unaligned,