Skip to main content

rl_lang/docs/entries/stdlib/debug/
assert_eq.rs

1use crate::docs::entry::FnEntry;
2
3pub static ASSERT_EQ: FnEntry = FnEntry {
4    signature: "assert_eq(a, b, msg?)",
5    description: "errors if `a` and `b` are not equal, reporting both values and their types in the default message",
6    example: r#"
7get std::debug::assert_eq
8
9assert_eq(2 + 2, 4)
10assert_eq(1, 2, \"math is broken\")"#,
11    expected_output: None,
12    returns: "null",
13    errors: Some("raises a runtime error when `a != b`"),
14    see_also: &["assert_ne", "assert_approx_eq"],
15    since: Some("v0.1.5"),
16};