nanval 0.2.1

A no_std, zero-dependency crate for the creation and handling of NaN-tagged 64-bit floating-point values.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

//! Handling of values marked as a 'uint' (`!SIGN_BIT | NAN_BITS`): 52-bit integers.

use super::{cons::*, IntoRawBits64};
use core::num::NonZeroU64;

/// Indicates that the value is a uint; the sign-bit is **not** set.
pub const UINT_MARKER_BITS: u64 = NAN_BITS;

/// Masks the bits ([`UINT_MARKER_BITS`]) that indicate that the value is a uint.
pub const UINT_MARKER_MASK: u64 = SIGN_BIT | NAN_BITS;

/// Masks the bits that actually hold the data of the uint.
pub const UINT_DATA_BITS: u64 = !UINT_MARKER_MASK;

/// Returns wether the given value is a uint.
#[inline(always)]
pub fn is_uint(value: impl IntoRawBits64) -> bool {
    (value.as_raw_bits_64() & (UINT_MARKER_MASK)) == UINT_MARKER_BITS
}

/// Returns wether the given value is *not* a uint.
#[inline(always)]
pub fn is_not_uint(value: impl IntoRawBits64) -> bool {
    (value.as_raw_bits_64() & (UINT_MARKER_MASK)) != UINT_MARKER_BITS
}

/// Unwraps the data of the given value as [`u64`], without checking if it is a uint.
#[inline(always)]
pub fn unwrap_uint_unchecked(value: impl IntoRawBits64) -> u64 {
    value.as_raw_bits_64() & UINT_DATA_BITS
}

/// Unwraps the data of the given value as [`u64`], if it is a uint.
#[inline(always)]
pub fn unwrap_uint(value: impl IntoRawBits64) -> Option<u64> {
    match is_uint(value) {
        true => Some(unwrap_uint_unchecked(value)),
        false => None
    }
}

/// Unwraps the data of the given value as [`NonZeroU64`], if it is a uint.
#[inline(always)]
pub fn unwrap_uint_nonzero(value: impl IntoRawBits64) -> Option<NonZeroU64> {
    match is_uint(value) {
        true => NonZeroU64::new(unwrap_uint_unchecked(value)),
        false => None
    }
}