Struct F64

#[repr(transparent)]
pub struct F64<O>(/* private field */, /* private field */);

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

F64 is like the native f64 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 F64 can be constructed using the new method, and its contained value can be obtained as a native f64 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 F64 has endianness O and that, b) the layout of f64 has the platform's native endianness.

F64 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> F64<O>

const ZERO: F64<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.

const fn from_bytes(bytes: [u8; 8]) -> F64<O>

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

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

Extracts the bytes of self without swapping the byte order.

The returned bytes will be in O byte order.

impl<O: ByteOrder> F64<O>

const fn new(n: f64) -> F64<O>

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

const fn get(self) -> f64

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.

fn set(&mut self, n: f64)

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> AsMut<[u8; 8]> for F64<O>

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

impl<O> AsRef<[u8; 8]> for F64<O>

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

impl<O> Default for F64<O>

fn default() -> F64<O>

impl<O> FromBytes for F64<O> where [u8; 8]: FromBytes, PhantomData<O>: FromBytes,

impl<O> FromZeros for F64<O> where [u8; 8]: FromZeros, PhantomData<O>: FromZeros,

impl<O> Immutable for F64<O> where [u8; 8]: Immutable, PhantomData<O>: Immutable,

impl<O> IntoBytes for F64<O> where [u8; 8]: IntoBytes, PhantomData<O>: IntoBytes,

impl<O> KnownLayout for F64<O> where Self: Sized,

type PointerMetadata = ();

impl<O> PartialEq<[u8; 8]> for F64<O>

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

impl<O> TryFromBytes for F64<O> where [u8; 8]: TryFromBytes, PhantomData<O>: TryFromBytes,

impl<O> Unaligned for F64<O> where [u8; 8]: Unaligned, PhantomData<O>: Unaligned,

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

type Output = F64<O>;
fn add(self, rhs: F64<O>) -> F64<O>

impl<O: ByteOrder> Add<f64> for F64<O>

type Output = F64<O>;
fn add(self, rhs: f64) -> F64<O>

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

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

impl<O: ByteOrder> AddAssign<f64> for F64<O>

fn add_assign(&mut self, rhs: f64)

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

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

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

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

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

type Output = F64<O>;
fn div(self, rhs: F64<O>) -> F64<O>

impl<O: ByteOrder> Div<f64> for F64<O>

type Output = F64<O>;
fn div(self, rhs: f64) -> F64<O>

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

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

impl<O: ByteOrder> DivAssign<f64> for F64<O>

fn div_assign(&mut self, rhs: f64)

impl<O: ByteOrder> From<[u8; 8]> for F64<O>

fn from(bytes: [u8; 8]) -> F64<O>

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

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

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

type Output = F64<O>;
fn mul(self, rhs: F64<O>) -> F64<O>

impl<O: ByteOrder> Mul<f64> for F64<O>

type Output = F64<O>;
fn mul(self, rhs: f64) -> F64<O>

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

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

impl<O: ByteOrder> MulAssign<f64> for F64<O>

fn mul_assign(&mut self, rhs: f64)

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

type Output = F64<O>;
fn neg(self) -> F64<O>

impl<O: ByteOrder> PartialEq<f64> for F64<O>

fn eq(&self, other: &f64) -> bool

impl<O: ByteOrder> PartialOrd for F64<O>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

type Output = F64<O>;
fn rem(self, rhs: F64<O>) -> F64<O>

impl<O: ByteOrder> Rem<f64> for F64<O>

type Output = F64<O>;
fn rem(self, rhs: f64) -> F64<O>

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

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

impl<O: ByteOrder> RemAssign<f64> for F64<O>

fn rem_assign(&mut self, rhs: f64)

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

type Output = F64<O>;
fn sub(self, rhs: F64<O>) -> F64<O>

impl<O: ByteOrder> Sub<f64> for F64<O>

type Output = F64<O>;
fn sub(self, rhs: f64) -> F64<O>

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

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

impl<O: ByteOrder> SubAssign<f64> for F64<O>

fn sub_assign(&mut self, rhs: f64)

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

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

impl<O: Clone> Clone for F64<O>

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

impl<O: Copy> Copy for F64<O>

impl<O: Eq> Eq for F64<O>

impl<O: Hash> Hash for F64<O>

fn hash<__H: Hasher>(&self, state: &mut __H)

impl<O: PartialEq> PartialEq for F64<O>

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

impl<O: PartialEq> StructuralPartialEq for F64<O>

Auto Trait Implementations

impl<O> Freeze for F64<O> where PhantomData<O>: Freeze,

impl<O> RefUnwindSafe for F64<O> where PhantomData<O>: RefUnwindSafe,

impl<O> Send for F64<O> where PhantomData<O>: Send,

impl<O> Sync for F64<O> where PhantomData<O>: Sync,

impl<O> Unpin for F64<O> where PhantomData<O>: Unpin,

impl<O> UnsafeUnpin for F64<O> where PhantomData<O>: UnsafeUnpin,

impl<O> UnwindSafe for F64<O> where PhantomData<O>: UnwindSafe,

Blanket Implementations

impl<T> Any for F64<O> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for F64<O> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for F64<O> where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for F64<O> where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for F64<O>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for F64<O> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for F64<O> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for F64<O> where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>