pub struct F32<O>(/* private fields */);
byteorder
only.Expand description
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
, AsBytes
, 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§
source§impl<O> F32<O>
impl<O> F32<O>
sourcepub const ZERO: 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.
sourcepub const fn from_bytes(bytes: [u8; 4]) -> F32<O>
pub const fn from_bytes(bytes: [u8; 4]) -> F32<O>
Constructs a new value from bytes which are already in the
endianness O
.
source§impl<O: ByteOrder> F32<O>
impl<O: ByteOrder> F32<O>
sourcepub fn new(n: f32) -> F32<O>
pub fn new(n: f32) -> F32<O>
Constructs a new value, possibly performing an endianness swap
to guarantee that the returned value has endianness O
.
Trait Implementations§
source§impl<O: ByteOrder> AddAssign for F32<O>
impl<O: ByteOrder> AddAssign for F32<O>
source§fn add_assign(&mut self, rhs: F32<O>)
fn add_assign(&mut self, rhs: F32<O>)
+=
operation. Read moresource§impl<O> AsBytes for F32<O>
impl<O> AsBytes for F32<O>
source§impl<O: ByteOrder> DivAssign for F32<O>
impl<O: ByteOrder> DivAssign for F32<O>
source§fn div_assign(&mut self, rhs: F32<O>)
fn div_assign(&mut self, rhs: F32<O>)
/=
operation. Read moresource§impl<O> FromBytes for F32<O>
impl<O> FromBytes for F32<O>
source§fn slice_from_prefix(bytes: &[u8], count: usize) -> Option<(&[Self], &[u8])>where
Self: Sized,
fn slice_from_prefix(bytes: &[u8], count: usize) -> Option<(&[Self], &[u8])>where
Self: Sized,
bytes
as a &[Self]
with length
equal to count
without copying. Read moresource§fn slice_from_suffix(bytes: &[u8], count: usize) -> Option<(&[u8], &[Self])>where
Self: Sized,
fn slice_from_suffix(bytes: &[u8], count: usize) -> Option<(&[u8], &[Self])>where
Self: Sized,
bytes
as a &[Self]
with length
equal to count
without copying. Read moresource§fn mut_slice_from_prefix(
bytes: &mut [u8],
count: usize,
) -> Option<(&mut [Self], &mut [u8])>
fn mut_slice_from_prefix( bytes: &mut [u8], count: usize, ) -> Option<(&mut [Self], &mut [u8])>
bytes
as a &mut [Self]
with length
equal to count
without copying. Read moresource§fn mut_slice_from_suffix(
bytes: &mut [u8],
count: usize,
) -> Option<(&mut [u8], &mut [Self])>
fn mut_slice_from_suffix( bytes: &mut [u8], count: usize, ) -> Option<(&mut [u8], &mut [Self])>
bytes
as a &mut [Self]
with length
equal to count
without copying. Read moresource§impl<O> FromZeroes for F32<O>
impl<O> FromZeroes for F32<O>
source§fn new_zeroed() -> Selfwhere
Self: Sized,
fn new_zeroed() -> Selfwhere
Self: Sized,
Self
from zeroed bytes. Read moresource§fn new_box_zeroed() -> Box<Self>where
Self: Sized,
fn new_box_zeroed() -> Box<Self>where
Self: Sized,
alloc
only.Box<Self>
from zeroed bytes. Read moresource§impl<O: ByteOrder> MulAssign for F32<O>
impl<O: ByteOrder> MulAssign for F32<O>
source§fn mul_assign(&mut self, rhs: F32<O>)
fn mul_assign(&mut self, rhs: F32<O>)
*=
operation. Read moresource§impl<O: ByteOrder> PartialEq<[u8; 4]> for F32<O>
impl<O: ByteOrder> PartialEq<[u8; 4]> for F32<O>
source§impl<O: ByteOrder> PartialEq<F32<O>> for [u8; 4]
impl<O: ByteOrder> PartialEq<F32<O>> for [u8; 4]
source§impl<O: PartialEq> PartialEq for F32<O>
impl<O: PartialEq> PartialEq for F32<O>
source§impl<O: ByteOrder> RemAssign for F32<O>
impl<O: ByteOrder> RemAssign for F32<O>
source§fn rem_assign(&mut self, rhs: F32<O>)
fn rem_assign(&mut self, rhs: F32<O>)
%=
operation. Read moresource§impl<O: ByteOrder> SubAssign for F32<O>
impl<O: ByteOrder> SubAssign for F32<O>
source§fn sub_assign(&mut self, rhs: F32<O>)
fn sub_assign(&mut self, rhs: F32<O>)
-=
operation. Read moreimpl<O: Copy> Copy for F32<O>
impl<O: Eq> Eq for F32<O>
impl<O> StructuralPartialEq for F32<O>
impl<O> Unaligned for F32<O>
Auto Trait Implementations§
impl<O> Freeze for F32<O>
impl<O> RefUnwindSafe for F32<O>where
O: RefUnwindSafe,
impl<O> Send for F32<O>where
O: Send,
impl<O> Sync for F32<O>where
O: Sync,
impl<O> Unpin for F32<O>where
O: Unpin,
impl<O> UnwindSafe for F32<O>where
O: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)