bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

add definition of 'allocated object', and link it from relevant method docs

Browse source
This commit is contained in:
Ralf Jung 2021-03-27 19:26:10 +01:00
parent f811f14006
commit b5d71bfb0f
3 changed files with 47 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

8
library/core/src/ptr/mod.rs
View file

@ -55,6 +55,14 @@
//! has size 0, i.e., even if memory is not actually touched. Consider using
//! [`NonNull::dangling`] in such cases.
//!
//! ## Allocated object
//!
//! For several operations, such as [`offset`] or field projections (`expr.field`), the notion of an
//! "allocated object" becomes relevant. An allocated object is a contiguous region of memory.
//! Common examples of allocated objects include stack-allocated variables (each variable is a
//! separate allocated object), heap allocations (each allocation created by the global allocator is
//! a separate allocated object), and `static` variables.
//!
//! [aliasing]: ../../nomicon/aliasing.html
//! [book]: ../../book/ch19-01-unsafe-rust.html#dereferencing-a-raw-pointer
//! [ub]: ../../reference/behavior-considered-undefined.html