#sorting #diff #pretty #debugging #assert #color

dev pretty_assertions_sorted

Wrapper around the rust-pretty-assertions crate that allows for the ability to sort the Debug output

5 stable releases

1.2.3 Jun 16, 2023
1.2.2 Jun 15, 2023
1.2.1 Sep 7, 2022
1.2.0 May 19, 2022
1.1.2 Dec 8, 2021

#117 in Development tools

Download history 1183/week @ 2023-12-23 6488/week @ 2023-12-30 6654/week @ 2024-01-06 6393/week @ 2024-01-13 8489/week @ 2024-01-20 9181/week @ 2024-01-27 7845/week @ 2024-02-03 5340/week @ 2024-02-10 4375/week @ 2024-02-17 3110/week @ 2024-02-24 5845/week @ 2024-03-02 4590/week @ 2024-03-09 17085/week @ 2024-03-16 26753/week @ 2024-03-23 11199/week @ 2024-03-30 9436/week @ 2024-04-06

65,276 downloads per month
Used in 6 crates


386 lines

Pretty Assertions (Sorted)

This crate wraps the pretty_assertions crate, which highlights differences in a test failure via a colorful diff.

However, the diff is based on the Debug output of the objects. For objects that have non-deterministic output, eg. two HashMaps with close to the same contents, the diff will be polluted and obscured with with false-positive differences like here:

standard assertion

This is much easier to understand when the diff is sorted:

sorted assertion

This is a pretty trivial example, you could solve this instead by converting the HashMap to a BTreeMap in your tests. But it's not always feasible to replace the types with ordered versions, especially for HashMaps that are deeply nested in types outside of your control.

To use the sorted version, import like this:

use pretty_assertions_sorted::{assert_eq, assert_eq_sorted};

assert_eq is provided as a re-export of pretty_assertions::assert_eq and should be used if you don't want the Debug output to be sorted, or if the Debug output can't be sorted (not supported types, eg. f64::NEG_INFINITY, or custom Debug output).


Specify it as [dev-dependencies] and it will only be used for compiling tests, examples, and benchmarks. This way the compile time of cargo build won't be affected!

License: MIT/Apache-2.0


~31K SLoC