Struct F64 

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

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>

pub 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.

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

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

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

where O: ByteOrder,

pub 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.

pub 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.

pub 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> Add<f64> for F64<O>

where O: ByteOrder,

type Output = F64<O>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<O> Add for F64<O>

where O: ByteOrder,

type Output = F64<O>

The resulting type after applying the + operator.

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

Performs the + operation.

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

where O: ByteOrder,

fn add_assign(&mut self, rhs: f64)

Performs the += operation.

impl<O> AddAssign for F64<O>

where O: ByteOrder,

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

Performs the += operation.

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

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

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

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

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

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

impl<O> Clone for F64<O>

where O: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<O> Debug for F64<O>

where O: ByteOrder,

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

Formats the value using the given formatter.

impl<O> Default for F64<O>

fn default() -> F64<O>

Returns the “default value” for a type.

impl<O> Display for F64<O>

where O: ByteOrder,

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

Formats the value using the given formatter.

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

where O: ByteOrder,

type Output = F64<O>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<O> Div for F64<O>

where O: ByteOrder,

type Output = F64<O>

The resulting type after applying the / operator.

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

Performs the / operation.

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

where O: ByteOrder,

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl<O> DivAssign for F64<O>

where O: ByteOrder,

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

Performs the /= operation.

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

where O: ByteOrder,

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

Converts to this type from the input type.

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

where O: ByteOrder, P: ByteOrder,

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

Converts to this type from the input type.

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

where O: ByteOrder,

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

Converts to this type from the input type.

impl<O> FromBytes for F64<O>

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

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

where Self: KnownLayout + Immutable,

Interprets the given source as a &Self.

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

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), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: Immutable + KnownLayout,

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

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

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), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

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

fn ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the given source as a &Self with a DST length equal to count.

fn ref_from_prefix_with_elems( source: &[u8], count: usize, ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the prefix of the given source as a DST &Self with length equal to count.

fn ref_from_suffix_with_elems( source: &[u8], count: usize, ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the suffix of the given source as a DST &Self with length equal to count.

fn mut_from_bytes_with_elems( source: &mut [u8], count: usize, ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the given source as a &mut Self with a DST length equal to count.

fn mut_from_prefix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize>,

Interprets the prefix of the given source as a &mut Self with DST length equal to count.

fn mut_from_suffix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize>,

Interprets the suffix of the given source as a &mut Self with DST length equal to count.

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

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

where O: Hash,

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

where __H: Hasher,

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

where [u8; 8]: 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 F64<O>

where F64<O>: Sized,

type PointerMetadata = ()

The type of metadata stored in a pointer to Self.

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

where O: ByteOrder,

type Output = F64<O>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<O> Mul for F64<O>

where O: ByteOrder,

type Output = F64<O>

The resulting type after applying the * operator.

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

Performs the * operation.

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

where O: ByteOrder,

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl<O> MulAssign for F64<O>

where O: ByteOrder,

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

Performs the *= operation.

impl<O> Neg for F64<O>

where O: ByteOrder,

type Output = F64<O>

The resulting type after applying the - operator.

fn neg(self) -> F64<O>

Performs the unary - operation.

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

fn eq(&self, other: &[u8; 8]) -> 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<f64> for F64<O>

where O: ByteOrder,

fn eq(&self, other: &f64) -> 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 for F64<O>

where O: PartialEq,

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

where O: ByteOrder,

fn partial_cmp(&self, other: &F64<O>) -> 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> Rem<f64> for F64<O>

where O: ByteOrder,

type Output = F64<O>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<O> Rem for F64<O>

where O: ByteOrder,

type Output = F64<O>

The resulting type after applying the % operator.

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

Performs the % operation.

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

where O: ByteOrder,

fn rem_assign(&mut self, rhs: f64)

Performs the %= operation.

impl<O> RemAssign for F64<O>

where O: ByteOrder,

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

Performs the %= operation.

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

where O: ByteOrder,

type Output = F64<O>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<O> Sub for F64<O>

where O: ByteOrder,

type Output = F64<O>

The resulting type after applying the - operator.

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

Performs the - operation.

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

where O: ByteOrder,

fn sub_assign(&mut self, rhs: f64)

Performs the -= operation.

impl<O> SubAssign for F64<O>

where O: ByteOrder,

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

Performs the -= operation.

impl<O> TryFromBytes for F64<O>

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

fn try_ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[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]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[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), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[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, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

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]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

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), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

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

fn try_ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the given source as a &Self with a DST length equal to count.

fn try_ref_from_prefix_with_elems( source: &[u8], count: usize, ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the prefix of the given source as a &Self with a DST length equal to count.

fn try_ref_from_suffix_with_elems( source: &[u8], count: usize, ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the suffix of the given source as a &Self with a DST length equal to count.

fn try_mut_from_bytes_with_elems( source: &mut [u8], count: usize, ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the given source as a &mut Self with a DST length equal to count.

fn try_mut_from_prefix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self with a DST length equal to count.

fn try_mut_from_suffix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self with a DST length equal to count.

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

where O: Copy,

impl<O> Eq for F64<O>

where O: Eq,

impl<O> Immutable for F64<O>

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

impl<O> StructuralPartialEq for F64<O>

impl<O> Unaligned for F64<O>

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