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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

/// Asserts that the expression matches a [`Poll::Pending`] variant.
///
/// ## Uses
///
/// Assertions are always checked in both debug and release builds, and cannot be disabled.
/// See [`debug_assert_pending!`] 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;
/// # use std::task::Poll;
/// # fn main() {
/// let res: Poll<i32> = Poll::Pending;
///
/// assert_pending!(res);
///
/// // With a custom message
/// assert_pending!(res, "Future is not ready yet");
/// # }
/// ```
///
/// A [`Poll::Pending`] variant will also be returned from this macro call:
///
/// ```rust
/// # #[macro_use] extern crate claims;
/// # use std::task::Poll;
/// # fn main() {
/// let res: Poll<i32> = Poll::Pending;
///
/// let value = assert_pending!(res);
/// assert_eq!(value, Poll::Pending);
/// # }
/// ```
///
/// A [`Poll::Ready(_)`] variant will panic:
///
/// ```rust,should_panic
/// # #[macro_use] extern crate claims;
/// # use std::task::Poll;
/// # fn main() {
/// let res = Poll::Ready(42);
///
/// assert_pending!(res);  // Will panic
/// # }
/// ```
///
/// [`Poll::Ready(_)`]: https://doc.rust-lang.org/core/task/enum.Poll.html#variant.Ready
/// [`Poll::Pending`]: https://doc.rust-lang.org/core/task/enum.Poll.html#variant.Pending
/// [`std::fmt`]: https://doc.rust-lang.org/std/fmt/index.html
/// [`debug_assert_pending!`]: crate::debug_assert_pending!
#[macro_export]
macro_rules! assert_pending {
    ($cond:expr $(,)?) => {
        match $cond {
            pending @ ::core::task::Poll::Pending => pending,
            ready @ ::core::task::Poll::Ready(_) => {
                ::core::panic!("assertion failed, expected Pending, got {:?}", ready);
            }
        }
    };
    ($cond:expr, $($arg:tt)+) => {
        match $cond {
            pending @ ::core::task::Poll::Pending => pending,
            ready @ ::core::task::Poll::Ready(_) => {
                ::core::panic!("assertion failed, expected Pending, got {:?}: {}", ready, ::core::format_args!($($arg)+));
            }
        }
    };
}

/// Asserts that the expression matches a [`Poll::Pending`] variant on debug builds.
///
/// This macro behaves the same as [`assert_pending!`] on debug builds. On release builds it is a
/// no-op.
///
/// [`Poll::Pending`]: https://doc.rust-lang.org/core/task/enum.Poll.html#variant.Pending
#[macro_export]
macro_rules! debug_assert_pending {
    ($($arg:tt)*) => {
        #[allow(unused_must_use)]
        #[cfg(debug_assertions)]
        {
            $crate::assert_pending!($($arg)*);
        }
    }
}

#[cfg(test)]
mod tests {
    use core::task::Poll::{Pending, Ready};

    #[test]
    fn pending() {
        let _ = assert_pending!(Pending::<()>);
    }

    #[test]
    #[should_panic(expected = "assertion failed, expected Pending, got Ready(())")]
    fn not_pending() {
        let _ = assert_pending!(Ready(()));
    }

    #[test]
    #[should_panic(expected = "assertion failed, expected Pending, got Ready(()): foo")]
    fn not_pending_custom_message() {
        let _ = assert_pending!(Ready(()), "foo");
    }

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

    #[test]
    #[cfg_attr(not(debug_assertions), ignore = "only run in debug mode")]
    #[should_panic(expected = "assertion failed, expected Pending, got Ready(())")]
    fn debug_not_pending() {
        debug_assert_pending!(Ready(()));
    }

    #[test]
    #[cfg_attr(not(debug_assertions), ignore = "only run in debug mode")]
    #[should_panic(expected = "assertion failed, expected Pending, got Ready(()): foo")]
    fn debug_not_pending_custom_message() {
        debug_assert_pending!(Ready(()), "foo");
    }

    #[test]
    #[cfg_attr(debug_assertions, ignore = "only run in release mode")]
    fn debug_release_not_pending() {
        debug_assert_pending!(Ready(()));
    }
}