summaryrefslogtreecommitdiffstats
path: root/vendor/countme/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/countme/README.md')
-rw-r--r--vendor/countme/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/vendor/countme/README.md b/vendor/countme/README.md
new file mode 100644
index 000000000..42f3c7ea8
--- /dev/null
+++ b/vendor/countme/README.md
@@ -0,0 +1,21 @@
+A library to quickly get the live/total/max counts of allocated instances.
+
+```rust
+#[derive(Default)]
+struct Widget {
+ _c: countme::Count<Self>,
+ ...
+}
+
+let w1 = Widget::default();
+let w2 = Widget::default();
+let w3 = Widget::default();
+drop(w1);
+
+let counts = countme::get::<Widget>();
+assert_eq!(counts.live, 2);
+assert_eq!(counts.max_live, 3);
+assert_eq!(counts.total, 3);
+
+eprintln!("{}", countme::get_all());
+```