caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-08-11 21:57:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for float.{to-bits, from-bits}

Browse Source
This commit is contained in:
+merlan #flirora 2025-02-07 18:15:34 -05:00
parent e4f8e57c53
commit a00aea82c5
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
crates/typst-library/src/foundations/float.rs
View File

@ -110,7 +110,8 @@ impl f64 {
f64::signum(self)
}
/// Converts bytes to a float.
/// Interprets bytes as a float in [IEEE 754](https://en.wikipedia.org/wiki/IEEE_754)
/// format.
///
/// ```example
/// #float.from-bytes(bytes((0, 0, 0, 0, 0, 0, 240, 63))) \
@ -120,8 +121,10 @@ impl f64 {
pub fn from_bytes(
/// The bytes that should be converted to a float.
///
/// Must be of length exactly 8 so that the result fits into a 64-bit
/// float.
/// Must have a length of either 4 or 8. The bytes are then
/// interpreted in the binary32 (single-precision) or
/// binary64 (double-precision) format depending on the
/// length of the bytes.
bytes: Bytes,
/// The endianness of the conversion.
#[named]
@ -145,7 +148,8 @@ impl f64 {
bail!("bytes must have a length of 4 or 8");
}
/// Converts a float to bytes.
/// Converts a float to bytes in [IEEE 754](https://en.wikipedia.org/wiki/IEEE_754)
/// format.
///
/// ```example
/// #array(1.0.to-bytes(endian: "big")) \
@ -158,6 +162,12 @@ impl f64 {
#[named]
#[default(Endianness::Little)]
endian: Endianness,
/// The size of the resulting bytes.
///
/// This must be either 4 or 8. The call will return the
/// representation of this float in either the binary32
/// (single-precision) or binary64 (double-precision) format
/// depending on the provided size.
#[named]
#[default(8)]
size: u32,