A direct replacement for `assert_eq` for unordered collections

Scott Meeuwsen

Last update: Nov 29, 2022

Related tags

Miscellaneous assert_unordered

Overview

assert_unordered

A direct replacement for assert_eq for unordered collections

This macro is useful for any situation where the ordering of the collection doesn't matter, even if they are always in the same order. This is because the stdlib assert_eq shows the entire collection for both left and right and leaves it up to the user to visually scan for differences. In contrast, this crate only works with collections (types that implement IntoIterator) and therefore can show only the differences (see below for an example of what the output looks like).

NOTE: As of 0.3.2, the output by default is in color similar to pretty_assertions

Usage

NOTE: no-default-features can be used to disable color output (and enable no-std support)

[dev-dependencies]
assert_unordered = "0.3"

Which Macro?

TLDR; - favor assert_eq_unordered_sort unless the trait requirements can't be met

assert_eq_unordered
- Requires only Debug and PartialEq on the elements
- Collection level equality check, and if unequal, falls back to item by item compare (O(n^2))
assert_eq_unordered_sort
- Requires Debug, Eq and Ord on the elements
- Collection level equality check, and if unequal, sorts and then compares again, and if still unequal, falls back to item by item compare (O(n^2))

Example

use assert_unordered::assert_eq_unordered;

#[derive(Debug, PartialEq)]
struct MyType(i32);

fn main() {
    let expected = vec![MyType(1), MyType(2), MyType(4), MyType(5)];
    let actual = vec![MyType(2), MyType(0), MyType(4)];

    assert_eq_unordered!(expected, actual);
}

Output:

License

This project is licensed optionally under either:

Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)

You might also like...

Freeze.rs is a payload toolkit for bypassing EDRs using suspended processes, direct syscalls written in RUST

Freeze.rs More Information If you want to learn more about the techniques utilized in this framework, please take a look at SourceZero Blog and the or

385 May 9, 2023

A direct ecs to low-level server implementation for Godot 4.1

godot_ecs What if Godot 4.1 and Bevy got married? Well, you'd get one interesting duo of data driven goodness. In Development This crate is not produc

5 Oct 6, 2023

Exploration of using Storage instead of Allocator to parameterize collections in Rust

storage-poc aims at exploring the usage of custom Storages, rather than custom Allocators. Goals This is a Proof-of-Concept aiming at: Demonstrating t

106 Dec 8, 2022

A number of collections, such as linked-lists, binary-trees, or B-Trees are most easily implemented with aliasing pointers.

StaticRc is a safe reference-counted pointer, similar to Rc or Arc, though performing its reference-counting at compile-time rather than run-time, and

372 Dec 19, 2022

A framework for iterating over collections of types implementing a trait without virtual dispatch

zero_v Zero_V is an experiment in defining behavior over collections of objects implementing some trait without dynamic polymorphism.

13 Jul 28, 2022

🚀 efficient approximate nearest neighbor search algorithm collections library written in Rust 🦀 .

2.3k Jan 3, 2023

visualizations/charts for media collections, based on mediainfo

Media Collection Viewer Early WIP! Demo is live Description Upload a mediainfo.json

14 Sep 14, 2022

🔎 A simple in-memory search for collections and key-value stores.

Indicium Search 🔎 A simple in-memory search for collections (Vec, HashMap, BTreeMap, etc) and key-value stores. Features autocompletion. There are ma

41 Oct 28, 2022

Some collections to store a fixed number of elements of a specific type.

This repo provide some useful data-structures, such as: Array, HashMap, HashSet, BTreeMap, BTreeSet, etc... That lives on the stack. It's a good choic

0 Nov 2, 2022

Darwinia networks' tracing runtime override collections

Darwinia Runtime Overrides USAGE: runtime-overrides [OPTIONS] --runtime CHAIN OPTIONS: -h, --help Print help information

4 Aug 3, 2022

A discord bot to view & monitor OpenSea collections, written in Rust

Titan What is this This is a discord bot to monitor OpenSea collections and get info about them, including: Floor Price Activity Sales per Hour And mo

3 Oct 11, 2022

An interface for managing collections of labeled items and generating random subsets with specified restrictions

3 Oct 30, 2022

Lexer and parser collections.

laps Lexer and parser collections. With laps, you can build parsers by just defining ASTs and deriving Parse trait for them. Usage Add laps to your pr

11 Jan 27, 2023

Human-friendly indexed collections

Indexical: Human-Friendly Indexed Collections Indexical is a library for conveniently and efficiently working with indexed collections of objects. "In

45 Nov 1, 2023

A modern replacement for ps written in Rust

procs procs is a replacement for ps written in Rust. Documentation quick links Features Platform Installation Usage Configuration Features Output by t

3.6k Jan 5, 2023

A modern replacement for ‘ls’.

exa exa is a modern replacement for ls. README Sections: Options — Installation — Development exa is a modern replacement for the venerable file-listi

20.3k Jan 6, 2023

Rust-based replacement for the default Minecraft renderer

wgpu-mc 🚀 A blazing fast alternative renderer for Minecraft Intro WebGPU is a new web specification designed to provide modern graphics and compute c

1 Jun 28, 2022

🍂 A Rust-based simulated DOM (browser-independent replacement for web_sys)

DOM in Rust without a browser Hello and welcome. This library provides server-side or browserless simulation of a DOM. Example Usage use std::sync::Ar

45 Dec 13, 2022

Rustyread is a drop in replacement of badread simulate.

Rustyread is a drop in replacement of badread simulate. Rustyread is very heavily inspired by badread, it reuses the same error and quality model file. But Rustyreads is multi-threaded and benefits from other optimizations.

20 Oct 1, 2022

Comments

Edge case with multiple identical values

These cases currently do not panic:

    assert_unordered::assert_eq_unordered!(vec![1, 1], vec![1]);
    assert_unordered::assert_eq_unordered!(vec![1, 1, 2], vec![1, 2, 2]);
    assert_unordered::assert_eq_unordered_set!(vec![1, 1], vec![1]);
    assert_unordered::assert_eq_unordered_set!(vec![1, 1, 2], vec![1, 2, 2]);

I like the nice error messages these asserts produce -- great idea!

bug enhancement

opened by ecton 3