From fff5a06f282ae6927fca1fbf8e8ed437e6772b9e Mon Sep 17 00:00:00 2001 From: Pyry Kontio Date: Thu, 31 Mar 2022 02:28:52 +0900 Subject: [PATCH] Add references to explanation about portability to f{32,64}::{from,to}_{be,le,ne}_bytes --- library/core/src/num/f32.rs | 18 ++++++++++++++++++ library/core/src/num/f64.rs | 18 ++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/library/core/src/num/f32.rs b/library/core/src/num/f32.rs index cae7c26941d0..b408b5d3d5de 100644 --- a/library/core/src/num/f32.rs +++ b/library/core/src/num/f32.rs @@ -902,6 +902,9 @@ pub const fn from_bits(v: u32) -> Self { /// Return the memory representation of this floating point number as a byte array in /// big-endian (network) byte order. /// + /// See [`from_bits`](Self::from_bits) for some discussion of the + /// portability of this operation (there are almost no issues). + /// /// # Examples /// /// ``` @@ -920,6 +923,9 @@ pub const fn from_bits(v: u32) -> Self { /// Return the memory representation of this floating point number as a byte array in /// little-endian byte order. /// + /// See [`from_bits`](Self::from_bits) for some discussion of the + /// portability of this operation (there are almost no issues). + /// /// # Examples /// /// ``` @@ -944,6 +950,9 @@ pub const fn from_bits(v: u32) -> Self { /// [`to_be_bytes`]: f32::to_be_bytes /// [`to_le_bytes`]: f32::to_le_bytes /// + /// See [`from_bits`](Self::from_bits) for some discussion of the + /// portability of this operation (there are almost no issues). + /// /// # Examples /// /// ``` @@ -968,6 +977,9 @@ pub const fn from_bits(v: u32) -> Self { /// Create a floating point value from its representation as a byte array in big endian. /// + /// See [`from_bits`](Self::from_bits) for some discussion of the + /// portability of this operation (there are almost no issues). + /// /// # Examples /// /// ``` @@ -984,6 +996,9 @@ pub const fn from_bits(v: u32) -> Self { /// Create a floating point value from its representation as a byte array in little endian. /// + /// See [`from_bits`](Self::from_bits) for some discussion of the + /// portability of this operation (there are almost no issues). + /// /// # Examples /// /// ``` @@ -1007,6 +1022,9 @@ pub const fn from_bits(v: u32) -> Self { /// [`from_be_bytes`]: f32::from_be_bytes /// [`from_le_bytes`]: f32::from_le_bytes /// + /// See [`from_bits`](Self::from_bits) for some discussion of the + /// portability of this operation (there are almost no issues). + /// /// # Examples /// /// ``` diff --git a/library/core/src/num/f64.rs b/library/core/src/num/f64.rs index eefb045073d7..db3961226518 100644 --- a/library/core/src/num/f64.rs +++ b/library/core/src/num/f64.rs @@ -918,6 +918,9 @@ pub const fn from_bits(v: u64) -> Self { /// Return the memory representation of this floating point number as a byte array in /// big-endian (network) byte order. /// + /// See [`from_bits`](Self::from_bits) for some discussion of the + /// portability of this operation (there are almost no issues). + /// /// # Examples /// /// ``` @@ -936,6 +939,9 @@ pub const fn from_bits(v: u64) -> Self { /// Return the memory representation of this floating point number as a byte array in /// little-endian byte order. /// + /// See [`from_bits`](Self::from_bits) for some discussion of the + /// portability of this operation (there are almost no issues). + /// /// # Examples /// /// ``` @@ -960,6 +966,9 @@ pub const fn from_bits(v: u64) -> Self { /// [`to_be_bytes`]: f64::to_be_bytes /// [`to_le_bytes`]: f64::to_le_bytes /// + /// See [`from_bits`](Self::from_bits) for some discussion of the + /// portability of this operation (there are almost no issues). + /// /// # Examples /// /// ``` @@ -984,6 +993,9 @@ pub const fn from_bits(v: u64) -> Self { /// Create a floating point value from its representation as a byte array in big endian. /// + /// See [`from_bits`](Self::from_bits) for some discussion of the + /// portability of this operation (there are almost no issues). + /// /// # Examples /// /// ``` @@ -1000,6 +1012,9 @@ pub const fn from_bits(v: u64) -> Self { /// Create a floating point value from its representation as a byte array in little endian. /// + /// See [`from_bits`](Self::from_bits) for some discussion of the + /// portability of this operation (there are almost no issues). + /// /// # Examples /// /// ``` @@ -1023,6 +1038,9 @@ pub const fn from_bits(v: u64) -> Self { /// [`from_be_bytes`]: f64::from_be_bytes /// [`from_le_bytes`]: f64::from_le_bytes /// + /// See [`from_bits`](Self::from_bits) for some discussion of the + /// portability of this operation (there are almost no issues). + /// /// # Examples /// /// ```