chek 0.1.0

An assertions 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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135


/// Panics if the provided values are not almost equal to eachother.
///
/// Uses the [`almost` crate](https://crates.io/crates/almost).
/// See [the `almost::equal` documentation](https://docs.rs/almost/%2a/almost/fn.equal.html)
/// for more details.
///
/// A debug-only version is available as `chek::debug_almost_equal!`.
///
/// Optionally may take an additional message to display on failure, which is
/// formatted using standard format syntax.
///
/// # Example
///
/// ```rust
/// chek::almost_equal!(4.0f32, 4.000001f32);
/// chek::almost_equal!(4.0, 4.0, "should be equal");
/// ```
#[macro_export]
macro_rules! almost_equal {
    ($left:expr, $right:expr $(,)?) => ({
        let (left, right) = ($left, $right);
        if !$crate::almost::equal(left, right) {
            $crate::__cmp_assert_fail!("almost_equal", &left, &right, stringify!($left), stringify!($right));
        }
    });
    ($left:expr, $right:expr, $($msg_args:tt)+) => ({
        let (left, right) = ($left, $right);
        if !$crate::almost::equal(left, right) {
            $crate::__cmp_assert_fail!("almost_equal", &left, &right, stringify!($left), stringify!($right), format_args!($($msg_args)+))
        }
    })
}

/// Same as `chek::almost_equal!` in debug builds or release builds where the `-C
/// debug-assertions` was provided to the compiler. For all other builds,
/// vanishes without a trace.
///
/// Optionally may take an additional message to display on failure, which is
/// formatted using standard format syntax.
///
/// # Example
///
/// ```rust
/// // These are compiled to nothing if debug_assertions are off!
/// chek::debug_almost_equal!(1.0f32, 1.0f32 + std::f32::EPSILON);
/// chek::debug_almost_equal!(3.0, 3.000005f32, "Example message");
/// ```
#[macro_export]
macro_rules! debug_almost_equal {
    ($left:expr, $right:expr $(,)?) => ({
        if cfg!(debug_assertions) {
            let (left, right) = ($left, $right);
            if !$crate::almost::equal(left, right) {
                $crate::__cmp_assert_fail!("debug_almost_equal", &left, &right, stringify!($left), stringify!($right));
            }
        }
    });
    ($left:expr, $right:expr, $($msg_args:tt)+) => ({
        if cfg!(debug_assertions) {
            let (left, right) = ($left, $right);
            if !$crate::almost::equal(left, right) {
                $crate::__cmp_assert_fail!("debug_almost_equal", &left, &right, stringify!($left), stringify!($right), format_args!($($msg_args)+))
            }
        }
    })
}

// Note: The 'with_tolerance' versions are hard to use, so not provided for now...

/// Panics if the provided values are almost equal to eachother.
///
/// Uses the [`almost` crate](https://crates.io/crates/almost).
/// See [the `almost::equal` documentation](https://docs.rs/almost/%2a/almost/fn.equal.html)
/// for more details.
///
/// A debug-only version is available as `chek::debug_not_almost_equal!`.
///
/// Optionally may take an additional message to display on failure, which is
/// formatted using standard format syntax.
///
/// # Example
///
/// ```rust
/// chek::not_almost_equal!(4.0, 5.0);
/// chek::not_almost_equal!(4.0, 5.0, "shouldn't be equal");
/// ```
#[macro_export]
macro_rules! not_almost_equal {
    ($left:expr, $right:expr $(,)?) => ({
        let (left, right) = ($left, $right);
        if $crate::almost::equal(left, right) {
            $crate::__cmp_assert_fail!("not_almost_equal", &left, &right, stringify!($left), stringify!($right));
        }
    });
    ($left:expr, $right:expr, $($msg_args:tt)+) => ({
        let (left, right) = ($left, $right);
        if $crate::almost::equal(left, right) {
            $crate::__cmp_assert_fail!("not_almost_equal", &left, &right, stringify!($left), stringify!($right), format_args!($($msg_args)+))
        }
    })
}

/// Same as `chek::not_almost_equal!` in debug builds or release builds where
/// the `-C debug-assertions` was provided to the compiler. For all other
/// builds, vanishes without a trace.
///
/// Optionally may take an additional message to display on failure, which is
/// formatted using standard format syntax.
///
/// # Example
///
/// ```rust
/// chek::debug_not_almost_equal!(4.0, 5.0);
/// chek::debug_not_almost_equal!(4.0, 5.0, "shouldn't be equal");
/// ```
#[macro_export]
macro_rules! debug_not_almost_equal {
    ($left:expr, $right:expr $(,)?) => ({
        if cfg!(debug_assertions) {
            let (left, right) = ($left, $right);
            if $crate::almost::equal(left, right) {
                $crate::__cmp_assert_fail!("debug_not_almost_equal", &left, &right, stringify!($left), stringify!($right));
            }
        }
    });
    ($left:expr, $right:expr, $($msg_args:tt)+) => ({
        if cfg!(debug_assertions) {
            let (left, right) = ($left, $right);
            if $crate::almost::equal(left, right) {
                $crate::__cmp_assert_fail!("debug_not_almost_equal", &left, &right, stringify!($left), stringify!($right), format_args!($($msg_args)+))
            }
        }
    })
}