Clarify allocated_bytes does not include headers

fitzgen · Nov 8, 2022 · 4dc20fa · 4dc20fa
1 parent 10492c6
commit 4dc20fa
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -1678,6 +1678,10 @@ impl Bump {
     /// on it only counting the sum of the sizes of the things
     /// you've allocated in the arena.
     ///
+    /// The allocated bytes do not include the sizes of bumpalo chunk headers,
+    /// so the amount of memory requested from the Rust allocator is higher
+    /// than the returned value.
+    ///
     /// ## Example
     ///
     /// ```