-
Notifications
You must be signed in to change notification settings - Fork 60
Added representation of pointer types. #51
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
13da89f
Added representation of pointer types.
049dc62
Moved same-representation discussion of fat pointers to non-normative…
ab527c7
Responding to review comments
872a405
Responding to review comments
be86083
Responding to review comments
db5f98d
Update reference/src/representation/pointers.md
RalfJung e2e6f0a
Responding to review comments
45d6eee
Added text about &str
7fb3b93
Added bullet points making size/alignment clearer
fc39320
Use *T rather than &T
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# Representation of reference and pointer types | ||
|
||
### Terminology | ||
|
||
Reference types are types of the form `&T`, `&mut T` or `&dyn T`. | ||
|
||
Raw pointer types are types of the form `*const T` or `*mut T`. | ||
We write `*T` when the mutability attribute is unimportant. | ||
|
||
### Representation | ||
|
||
The alignment of `&T`, `&mut T`, `*const T` and `*mut T` are the same, | ||
and are at least the word size. | ||
|
||
* If `T` is a trait, then the alignment of `&dyn T` is the word size. | ||
* If `T` is a sized type then the alignment of `&T` is the word size. | ||
* The alignment of `&[T]` is the word size. | ||
* The alignment of `&str` is the word size. | ||
* Alignment in other cases may be more than the word size (e.g., for other dynamically sized types). | ||
|
||
The sizes of `&T`, `&mut T`, `*const T` and `*mut T` are the same, | ||
and are at least one word. | ||
|
||
* If `T` is a trait, then the size of `&dyn T` is two words. | ||
* If `T` is a sized type then the size of `&T` is one word. | ||
* The size of `&[T]` is two words. | ||
* The size of `&str` is two words. | ||
* Size in other cases may be more than one word (e.g., for other dynamically sized types). | ||
|
||
### Notes | ||
|
||
The representations of `&T`, `&mut T` and `*T` are the same. | ||
|
||
We do not make any guarantees about the representation of | ||
multi-trait objects `&(dyn T + U)` or references to other dynamically sized types, | ||
other than that they are at least word-aligned, and have size at least one word. | ||
|
||
The representation of `&dyn T` when `T` is a trait is the same as that of: | ||
```rust | ||
#[repr(C)] | ||
struct DynObject { | ||
data: *u8, | ||
vtable: *u8, | ||
} | ||
``` | ||
|
||
The representation of `&[T]` is the same as that of: | ||
```rust | ||
#[repr(C)] | ||
struct Slice<T> { | ||
ptr: *T, | ||
len: usize, | ||
} | ||
``` | ||
|
||
The representation of `&str` is the same as that of `&[u8]`. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.