claims 0.8.0

Additional assertion macros for testing.
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

/// Asserts that the expression is [`None`].
///
/// ## Uses
///
/// Assertions are always checked in both debug and release builds, and cannot be disabled.
/// See [`debug_assert_none!`] for assertions that are not enabled in release builds by default.
///
/// ## Custom messages
///
/// This macro has a second form, where a custom panic message can be provided with or without
/// arguments for formatting. See [`std::fmt`] for syntax for this form.
///
/// ## Examples
///
/// ```rust
/// # #[macro_use] extern crate claims;
/// # fn main() {
/// let maybe: Option<i32> = None;
///
/// assert_none!(maybe);
///
/// // With a custom message
/// assert_none!(maybe, "Yep, there is nothing in here");
/// assert_none!(maybe, "we asserting that there are no droids we are looking for at {:?}", maybe);
/// # }
/// ```
///
/// A `Some(_)` variant will panic:
///
/// ```rust,should_panic
/// # #[macro_use] extern crate claims;
/// # fn main() {
/// let maybe = Some(42i32);
///
/// assert_none!(maybe);  // Will panic
/// # }
/// ```
///
/// [`None`]: https://doc.rust-lang.org/core/option/enum.Option.html#variant.None
/// [`std::fmt`]: https://doc.rust-lang.org/std/fmt/index.html
/// [`debug_assert_none!`]: crate::debug_assert_none!
#[macro_export]
macro_rules! assert_none {
    ($cond:expr $(,)?) => {
        match $cond {
            none @ ::core::option::Option::None => none,
            some @ ::core::option::Option::Some(_) => {
                ::core::panic!("assertion failed, expected None, got {:?}", some);
            }
        }
    };
    ($cond:expr, $($arg:tt)+) => {
        match $cond {
            none @ ::core::option::Option::None => none,
            some @ ::core::option::Option::Some(_) => {
                ::core::panic!("assertion failed, expected None, got {:?}: {}", some, ::core::format_args!($($arg)+));
            }
        }
    };
}

/// Asserts that the expression is [`None`] on debug builds.
///
/// This macro behaves the same as [`assert_none!`] on debug builds. On release builds it is a
/// no-op.
#[macro_export]
macro_rules! debug_assert_none {
    ($($arg:tt)*) => {
        #[cfg(debug_assertions)]
        $crate::assert_none!($($arg)*);
    }
}

#[cfg(test)]
mod tests {
    #[test]
    fn none() {
        assert_none!(None::<()>);
    }

    #[test]
    #[should_panic(expected = "assertion failed, expected None, got Some(())")]
    fn not_none() {
        assert_none!(Some(()));
    }

    #[test]
    #[should_panic(expected = "assertion failed, expected None, got Some(()): foo")]
    fn not_none_custom_message() {
        assert_none!(Some(()), "foo");
    }

    #[test]
    #[cfg_attr(not(debug_assertions), ignore = "only run in debug mode")]
    fn debug_none() {
        debug_assert_none!(None::<()>);
    }

    #[test]
    #[cfg_attr(not(debug_assertions), ignore = "only run in debug mode")]
    #[should_panic(expected = "assertion failed, expected None, got Some(())")]
    fn debug_not_none() {
        debug_assert_none!(Some(()));
    }

    #[test]
    #[cfg_attr(not(debug_assertions), ignore = "only run in debug mode")]
    #[should_panic(expected = "assertion failed, expected None, got Some(()): foo")]
    fn debug_not_none_custom_message() {
        debug_assert_none!(Some(()), "foo");
    }

    #[test]
    #[cfg_attr(debug_assertions, ignore = "only run in release mode")]
    fn debug_release_not_none() {
        debug_assert_none!(Some(()));
    }
}