Skip to content

Document that slice refers to any pointer type to a sequence #75028

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

Merged
merged 4 commits into from
Aug 23, 2020
Merged

Document that slice refers to any pointer type to a sequence #75028

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e6c83dd
Document that slice means pointer to a sequence
LeonMatthes Aug 1, 2020
a9af93b
Add missing period
LeonMatthes Aug 1, 2020
41d3e1c
Add missing import to Rc
LeonMatthes Aug 1, 2020
cf76256
Revert changed paragraph about slice definition.
LeonMatthes Aug 23, 2020
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
18 changes: 16 additions & 2 deletions library/std/src/primitive_docs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -565,8 +565,8 @@ mod prim_array {}
///
/// *[See also the `std::slice` module](slice/index.html).*
///
/// Slices are a view into a block of memory represented as a pointer and a
/// length.
/// A slice is any pointer/reference to a block of memory. They are represented
/// as a regular pointer and a length.
///
/// ```
/// // slicing a Vec
Expand All @@ -587,6 +587,20 @@ mod prim_array {}
/// x[1] = 7;
/// assert_eq!(x, &[1, 7, 3]);
/// ```
///
/// As slices store the length of the sequence they refer to, they have twice
/// the size of pointers to [`Sized`](marker/trait.Sized.html) types.
/// Also see the reference on
/// [dynamically sized types](../reference/dynamically-sized-types.html).
///
/// ```
/// # use std::rc::Rc;
/// let pointer_size = std::mem::size_of::<&u8>();
/// assert_eq!(2 * pointer_size, std::mem::size_of::<&[u8]>());
/// assert_eq!(2 * pointer_size, std::mem::size_of::<*const [u8]>());
/// assert_eq!(2 * pointer_size, std::mem::size_of::<Box<[u8]>>());
/// assert_eq!(2 * pointer_size, std::mem::size_of::<Rc<[u8]>>());
/// ```
#[stable(feature = "rust1", since = "1.0.0")]
mod prim_slice {}

Expand Down