Skip to content

Commit

Permalink
Document heap allocation location guarantee
Browse files Browse the repository at this point in the history
  • Loading branch information
aidanhs committed Mar 20, 2016
1 parent 2af3dd7 commit bb43f58
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/doc/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -3909,6 +3909,9 @@ The _heap_ is a general term that describes boxes. The lifetime of an
allocation in the heap depends on the lifetime of the box values pointing to
it. Since box values may themselves be passed in and out of frames, or stored
in the heap, heap allocations may outlive the frame they are allocated within.
An allocation in the heap is guaranteed to reside at a single location in the
heap for the whole lifetime of the allocation - it will never be relocated as
a result of moving a box value.

### Memory ownership

Expand Down

0 comments on commit bb43f58

Please sign in to comment.