diff options
| author | Ralf Jung <post@ralfj.de> | 2024-03-25 20:18:46 +0100 |
|---|---|---|
| committer | Ralf Jung <post@ralfj.de> | 2024-03-25 20:18:46 +0100 |
| commit | 7731135af25495bf8eb1cd2f599755f7a0bba37d (patch) | |
| tree | afa87b136b6f8551412656e64d967b351cd03455 /library/core/src/alloc/layout.rs | |
| parent | cb7c63606e53715f94f3ba04d38e50772e4cd23d (diff) | |
| download | rust-7731135af25495bf8eb1cd2f599755f7a0bba37d.tar.gz rust-7731135af25495bf8eb1cd2f599755f7a0bba37d.zip | |
alloc::Layout: explicitly document size invariant on the type level
Diffstat (limited to 'library/core/src/alloc/layout.rs')
| -rw-r--r-- | library/core/src/alloc/layout.rs | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/library/core/src/alloc/layout.rs b/library/core/src/alloc/layout.rs index 2a02870e30b..0b92767c932 100644 --- a/library/core/src/alloc/layout.rs +++ b/library/core/src/alloc/layout.rs @@ -25,7 +25,9 @@ const fn size_align<T>() -> (usize, usize) { /// An instance of `Layout` describes a particular layout of memory. /// You build a `Layout` up as an input to give to an allocator. /// -/// All layouts have an associated size and a power-of-two alignment. +/// All layouts have an associated size and a power-of-two alignment. The size, when rounded up to +/// the nearest multiple of `align`, does not overflow isize (i.e., the rounded value will always be +/// less than or equal to `isize::MAX`). /// /// (Note that layouts are *not* required to have non-zero size, /// even though `GlobalAlloc` requires that all memory requests |
