Run some Rust code while counting allocations. Can be used to assert that the desired amount of memory allocations is not exceeded in tests.
It works by replacing the System allocator with a custom one which increases a thread local counter on each memory allocation before delegating to the normal system allocator.
Add as a dependency - since including the trait replaces the global memory allocator, you most likely want it gated behind a feature:
```toml [features] count-allocations = ["allocation-counter"]
[dependencies] allocation-counter = { version = "0", optional = true } ```
Tests can now be written to assert that the number of desired memory allocations are not exceeded:
```rust
pub fn nomemoryallocations() { let allocations = allocationcounter::count(|| { codethatshouldnotallocatememory(); }); assert_eq!(allocations, 0); } ```
Run the tests with the necessary feature enabled:
sh
cargo test --features count-allocations