lance-core 4.0.0

Lance Columnar Format -- Core Library
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

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright The Lance Authors

/// A macro that combines debug_assert and std::hint::assert_unchecked for optimized assertions
///
/// In debug builds, this will perform a normal assertion check.
/// In release builds, this will use hint::assert_unchecked which tells the compiler to assume
/// the condition is true without actually checking it.
///
/// # Safety
///
/// This macro is unsafe in release builds since it uses hint::assert_unchecked.
/// The caller must ensure the condition will always be true.
#[macro_export]
macro_rules! assume {
    ($cond:expr) => {
        debug_assert!($cond);
        // SAFETY: The debug_assert ensures this is true in debug builds.
        // In release builds, caller must ensure the condition holds.
        unsafe { std::hint::assert_unchecked($cond); }
    };
    ($cond:expr, $($arg:tt)+) => {
        debug_assert!($cond, $($arg)+);
        // SAFETY: The debug_assert ensures this is true in debug builds.
        // In release builds, caller must ensure the condition holds.
        unsafe { std::hint::assert_unchecked($cond); }
    };
}

/// Helper macro for equality assumptions.
#[macro_export]
macro_rules! assume_eq {
    ($left:expr, $right:expr) => {
        debug_assert_eq!($left, $right);
        unsafe { std::hint::assert_unchecked($left == $right); }
    };
    ($left:expr, $right:expr, $($arg:tt)+) => {
        debug_assert_eq!($left, $right, $($arg)+);
        unsafe { std::hint::assert_unchecked($left == $right); }
    };
}