Skip to content

Commit 5805a29

Browse files
committed
Clarify allocated_bytes does not include headers
1 parent 10492c6 commit 5805a29

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/lib.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1678,6 +1678,10 @@ impl Bump {
16781678
/// on it only counting the sum of the sizes of the things
16791679
/// you've allocated in the arena.
16801680
///
1681+
/// The allocated bytes do not include the size of bumpalo's metadata,
1682+
/// so the amount of memory requested from the Rust allocator is higher
1683+
/// than the returned value.
1684+
///
16811685
/// ## Example
16821686
///
16831687
/// ```

0 commit comments

Comments
 (0)