From 5805a293e8ba99f2adfd9c02ee6ad2532ad52fca Mon Sep 17 00:00:00 2001 From: Stiopa Koltsov Date: Thu, 3 Nov 2022 01:53:52 +0000 Subject: [PATCH] Clarify allocated_bytes does not include headers --- src/lib.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index be68365..74dfcd4 100644 --- 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 size of bumpalo's metadata, + /// so the amount of memory requested from the Rust allocator is higher + /// than the returned value. + /// /// ## Example /// /// ```