foster/denoland-rusty-v8
0
0
Fork 0
mirror of https://github.com/denoland/rusty_v8.git synced 2024-12-25 08:39:15 -05:00
Code Issues Activity

Fix misleading BigInt rustdoc (#1379)

Browse source 
* Fix misleading BigInt rustdoc

The original documentation was unclear about the value of the bool. I interpreted it as being `true` if the value was truncated.
This commit is contained in:
Guillaume Bort 2024-02-03 18:44:56 +01:00 committed by GitHub
parent 54e93385b8
commit 477f5af361
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/bigint.rs
View file

@ -79,9 +79,9 @@ impl BigInt {
}
/// Returns the value of this BigInt as an unsigned 64-bit integer, and a
/// `bool` indicating whether the return value was truncated was truncated or
/// wrapped around. In particular, it will be `false` if this BigInt is
/// negative.
/// `bool` indicating that the conversion was lossless when `true`.
/// The boolean value will be `false` if the return value was truncated or wrapped around,
/// in particular if the BigInt is negative.
#[inline(always)]
pub fn u64_value(&self) -> (u64, bool) {
let mut lossless = MaybeUninit::uninit();
@ -91,7 +91,8 @@ impl BigInt {
}
/// Returns the value of this BigInt as a signed 64-bit integer, and a `bool`
/// indicating whether this BigInt was truncated or not.
/// indicating that the conversion was lossless when `true`.
/// The boolean value will be `false` if the return value was truncated or wrapped around.
#[inline(always)]
pub fn i64_value(&self) -> (i64, bool) {
let mut lossless = MaybeUninit::uninit();