doc: add a "primitive type reference" page #33516
Closed
Conversation
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
While it is not useful to list impls here, and there are no inherent methods, references are still a primitive (and very important) type and should get an entry in the overview on http://doc.rust-lang.org/std/#primitives and a place to put general verbiage about references, and probably a reference to the book. We do *not* add links to this page from other types, like we do for `&[T]`, because that would likely be more confusing than helpful. Fixes: rust-lang#15654
|
Nice, I would like to see this. @alexcrichton is this the right way to do this? It feels right to me, but would like to double check. |
| /// are represented as pointers, but the compiler can statically ensure that no | ||
| /// unsafety results from passing and dereferencing them. | ||
| /// | ||
| /// Shared references (`&T`) allow read-only access to the pointee, while |
There was a problem hiding this comment.
This is somewhat nuanced where types like &Cell<T> are actually read/write, not just read only. Perhaps this could just indicate "allows aliasing"?
There was a problem hiding this comment.
Also, the official term is just "reference", not "shared reference"
|
Are there any incoming links to this page anywhere as well? |
| // | ||
| /// Borrowed references, `&T`, and `&mut T`. | ||
| /// | ||
| /// References fundamental to Rust's system of ownership and borrowing. They |
|
Closing due to inactivity, but feel free to reopen with comments addressed! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
While it is not useful to list impls here, and there are no inherent methods, references are still a primitive (and very important) type and should get an entry in the overview on http://doc.rust-lang.org/std/#primitives and a place to put general verbiage about references, and probably a reference to the book.
We do not add links to this page from other types, like we do for
&[T], because that would likely be more confusing than helpful.Fixes: #15654
r? @steveklabnik - the documentation I put in primitive_docs.rs is just a placeholder for what you'd like to put there :)