Skip to content

Commit 3d8d557

Browse files
ashleygwilliamsashleygwilliams
committed
add assert_ne and debug_assert_ne macros
1 parent c772948 commit 3d8d557

File tree

4 files changed

+100
-2
lines changed

4 files changed

+100
-2
lines changed

‎src/libcore/macros.rs

+63
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,44 @@ macro_rules! assert_eq {
119119
});
120120
}
121121

122+
/// Asserts that two expressions are not equal to each other.
123+
///
124+
/// On panic, this macro will print the values of the expressions with their
125+
/// debug representations.
126+
///
127+
/// # Examples
128+
///
129+
/// ```
130+
/// let a = 3;
131+
/// let b = 2;
132+
/// assert_ne!(a, b);
133+
/// ```
134+
#[macro_export]
135+
#[stable(feature = "assert_ne", since = "1.12.0")]
136+
macro_rules! assert_ne {
137+
($left:expr , $right:expr) => ({
138+
match (&$left, &$right) {
139+
(left_val, right_val) => {
140+
if *left_val == *right_val {
141+
panic!("assertion failed: `(left != right)` \
142+
(left: `{:?}`, right: `{:?}`)", left_val, right_val)
143+
}
144+
}
145+
}
146+
});
147+
($left:expr , $right:expr, $($arg:tt)*) => ({
148+
match (&($left), &($right)) {
149+
(left_val, right_val) => {
150+
if *left_val == *right_val {
151+
panic!("assertion failed: `(left != right)` \
152+
(left: `{:?}`, right: `{:?}`): {}", left_val, right_val,
153+
format_args!($($arg)*))
154+
}
155+
}
156+
}
157+
});
158+
}
159+
122160
/// Ensure that a boolean expression is `true` at runtime.
123161
///
124162
/// This will invoke the `panic!` macro if the provided expression cannot be
@@ -189,6 +227,31 @@ macro_rules! debug_assert_eq {
189227
($($arg:tt)*) => (if cfg!(debug_assertions) { assert_eq!($($arg)*); })
190228
}
191229

230+
/// Asserts that two expressions are not equal to each other.
231+
///
232+
/// On panic, this macro will print the values of the expressions with their
233+
/// debug representations.
234+
///
235+
/// Unlike `assert_ne!`, `debug_assert_ne!` statements are only enabled in non
236+
/// optimized builds by default. An optimized build will omit all
237+
/// `debug_assert_ne!` statements unless `-C debug-assertions` is passed to the
238+
/// compiler. This makes `debug_assert_ne!` useful for checks that are too
239+
/// expensive to be present in a release build but may be helpful during
240+
/// development.
241+
///
242+
/// # Examples
243+
///
244+
/// ```
245+
/// let a = 3;
246+
/// let b = 2;
247+
/// debug_assert_ne!(a, b);
248+
/// ```
249+
#[macro_export]
250+
#[stable(feature = "assert_ne", since = "1.12.0")]
251+
macro_rules! debug_assert_ne {
252+
($($arg:tt)*) => (if cfg!(debug_assertions) { assert_ne!($($arg)*); })
253+
}
254+
192255
/// Helper macro for reducing boilerplate code for matching `Result` together
193256
/// with converting downstream errors.
194257
///

‎src/libstd/lib.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -304,8 +304,8 @@ use prelude::v1::*;
304304
// We want to reexport a few macros from core but libcore has already been
305305
// imported by the compiler (via our #[no_std] attribute) In this case we just
306306
// add a new crate name so we can attach the reexports to it.
307-
#[macro_reexport(assert, assert_eq, debug_assert, debug_assert_eq,
308-
unreachable, unimplemented, write, writeln, try)]
307+
#[macro_reexport(assert, assert_eq, assert_ne, debug_assert, debug_assert_eq,
308+
debug_assert_ne, unreachable, unimplemented, write, writeln, try)]
309309
extern crate core as __core;
310310

311311
#[macro_use]

‎src/test/run-pass/assert-ne-macro-success.rs

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Copyright 2016 The Rust Project Developers. See the COPYRIGHT
2+
// file at the top-level directory of this distribution and at
3+
// http://rust-lang.org/COPYRIGHT.
4+
//
5+
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6+
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7+
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8+
// option. This file may not be copied, modified, or distributed
9+
// except according to those terms.
10+
11+
#[derive(PartialEq, Debug)]
12+
struct Point { x : isize }
13+
14+
pub fn main() {
15+
assert_ne!(666,14);
16+
assert_ne!("666".to_string(),"abc".to_string());
17+
assert_ne!(Box::new(Point{x:666}),Box::new(Point{x:34}));
18+
assert_ne!(&Point{x:666},&Point{x:34});
19+
assert_ne!(666, 42, "no gods no masters");
20+
assert_ne!(666, 42, "6 {} 6", "6");
21+
assert_ne!(666, 42, "{x}, {y}, {z}", x = 6, y = 6, z = 6);
22+
}

‎src/test/run-pass/assert-ne-macro-unsized.rs

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// Copyright 2016 The Rust Project Developers. See the COPYRIGHT
2+
// file at the top-level directory of this distribution and at
3+
// http://rust-lang.org/COPYRIGHT.
4+
//
5+
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6+
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7+
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8+
// option. This file may not be copied, modified, or distributed
9+
// except according to those terms.
10+
11+
pub fn main() {
12+
assert_ne!([6, 6, 6][..], vec![1, 2, 3][..]);
13+
}

0 commit comments

Comments
 (0)