Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Attempt to explain that &mut cannot alias #1198

Closed
wants to merge 1 commit into from
Closed

Attempt to explain that &mut cannot alias #1198

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/types/pointer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ These also point to memory owned by some other value.
A mutable reference type is written `&mut type` or `&'a mut type`.
A mutable reference (that hasn't been borrowed) is the only way to access the value it points to, so is not `Copy`.

While a mutable reference is alive, it is the only reference pointing to the referent; no other reference,
mutable or shared, point to the same value. For the safe subset of the language, this constraint is
verified by the compiler. For code that use `unsafe`, it's up to the programmer to follow this constraint to avoid
[undefined behavior] for correctness.

## Raw pointers (`*const` and `*mut`)

> **<sup>Syntax</sup>**\
Expand Down Expand Up @@ -58,3 +63,4 @@ The standard library contains additional 'smart pointer' types beyond references
[`unsafe` operation]: ../unsafety.md
[dynamically sized types]: ../dynamically-sized-types.md
[temporary value]: ../expressions.md#temporaries
[undefined behavior]: ../behavior-considered-undefined.md