assert_eq 0.2.0

assert_eq: location-aware equality assertions
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

# `assert_eq!` macro

This crate provides a custom `assert_eq!` macro that gives detailed error messages when comparing complex data structures. It supports nested structures, collections, and provides a path to the first point of difference.

A quick example:

```rust ,should_panic
use assert_eq::AssertEq;
#[derive(AssertEq, Debug)]
struct A {
    x: String,
    y: Vec<i32>,
}

#[derive(AssertEq, Debug)]
struct B {
    x: A,
    y: Vec<i32>,
}

let x = B {
    x: A {
        x: "hello".to_string(),
        y: vec![1, 2, 3],
    },
    y: vec![4, 5, 6],
};

let y = B {
    x: A {
        x: "hello".to_string(),
        y: vec![1, 2, 8],
    },
    y: vec![4, 5, 6],
};

assert_eq::assert_eq!(x, y); // at .x → .y → [2] left: 3 right: 8
```

Running this code will panic with the following message:

```text
assertion `left == right` failed: at .x → .y → [2]
  left: 3
 right: 8
assert_eq! called initially on:
  left: B { x: A { x: "hello", y: [1, 2, 3] }, y: [4, 5, 6] }
 right: B { x: A { x: "hello", y: [1, 2, 8] }, y: [4, 5, 6] }
```

It is `no_std` compatible, but requires the `alloc` crate.