rapidhash 4.2.0

An extremely fast, high quality, platform-independent hashing algorithm.
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
50
51
52
53
54
55
56
57
58

/// Wraps the `core::hint::likely` intrinsic if the `nightly` feature is enabled.
#[inline(always)]
pub(crate) const fn likely(x: bool) -> bool {
    #[cfg(feature = "nightly")] {
        core::hint::likely(x)
    }

    #[cfg(not(feature = "nightly"))] {
        if !x {
            cold_path();
        }

        x
    }
}

/// Wraps the `core::hint::unlikely` intrinsic if the `nightly` feature is enabled.
#[inline(always)]
pub(crate) const fn unlikely(x: bool) -> bool {
    #[cfg(feature = "nightly")] {
        core::hint::unlikely(x)
    }

    #[cfg(not(feature = "nightly"))] {
        if x {
            cold_path();
        }

        x
    }
}

#[allow(dead_code)]
#[cold]
#[inline(always)]
const fn cold_path() {}

/// Provides a stable `assume` function that uses `core::hint::assert_unchecked` when the stable
/// rust compiler supports it.
///
/// This is particularly relevant when LLVM isn't able to specialise the >16 input functions. This
/// often happens with the default release profile, which uses a large number of codegen units and
/// LTO off.
#[cfg_attr(not(docsrs), rustversion::since(1.81))]
#[inline(always)]
pub(crate) const unsafe fn assume(cond: bool) {
    debug_assert!(cond);
    core::hint::assert_unchecked(cond);
}

/// Provides a stable `assume` function that uses `core::hint::assert_unchecked` when the stable
/// rust compiler supports it.
#[cfg_attr(not(docsrs), rustversion::before(1.81))]
#[cfg_attr(docsrs, cfg(not(docsrs)))]
#[inline(always)]
pub(crate) const unsafe fn assume(cond: bool) {
    debug_assert!(cond);
}