Struct zerocopy::byteorder::F32

#[repr(transparent)]
pub struct F32<O>(_, _);

A 32-bit floating point number stored in O 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.

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

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 the endianness O.

impl<O: ByteOrder> 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.

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

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

Gets the bytes of this value.

fn as_bytes_mut(&mut self) -> &mut [u8]where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to<B: ByteSliceMut>(&self, bytes: B) -> Option<()>

Writes a copy of self to bytes.

fn write_to_prefix<B: ByteSliceMut>(&self, bytes: B) -> Option<()>

Writes a copy of self to the prefix of bytes.

fn write_to_suffix<B: ByteSliceMut>(&self, bytes: B) -> Option<()>

Writes a copy of self to the suffix of bytes.

impl<O: ByteOrder> 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: ByteOrder> 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> 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 PhantomData<O>: FromBytes, [u8; 4]: FromBytes,

fn read_from<B: ByteSlice>(bytes: B) -> Option<Self>where Self: Sized,

Reads a copy of Self from bytes.

fn read_from_prefix<B: ByteSlice>(bytes: B) -> Option<Self>where Self: Sized,

Reads a copy of Self from the prefix of bytes.

fn read_from_suffix<B: ByteSlice>(bytes: B) -> Option<Self>where Self: Sized,

Reads a copy of Self from the suffix of bytes.

fn new_zeroed() -> Selfwhere Self: Sized,

Creates an instance of Self from zeroed bytes.

fn new_box_zeroed() -> Box<Self>where Self: Sized,

Creates a Box<Self> from zeroed bytes.

fn new_box_slice_zeroed(len: usize) -> Box<[Self]>where Self: Sized,

Creates a Box<[Self]> (a boxed slice) from zeroed bytes.

fn new_vec_zeroed(len: usize) -> Vec<Self>where Self: Sized,

Creates a Vec<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: ByteOrder> PartialEq<[u8; 4]> for F32<O>

fn eq(&self, other: &[u8; 4]) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn eq(&self, other: &F32<O>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<O: PartialEq> PartialEq<F32<O>> for F32<O>

fn eq(&self, other: &F32<O>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

impl<O> StructuralEq for F32<O>

impl<O> StructuralPartialEq for F32<O>

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