Auto merge of #75028 - MrModder:master, r=steveklabnik
Document that slice refers to any pointer type to a sequence I was recently confused about the way slices are represented in memory. The necessary information was not available in the std-docs directly, but was a mix of different material from the reference and book. This PR should clear up the definition of slices a bit more in the documentation. Especially the fact that the term slice refers to the pointer/reference type, e.g. `&[T]`, and not `[T]`. It also documents that slice pointers are twice the size of pointers to `Sized` types, as this concept may be unfamiliar to users coming from other languages that do not have the concept of "fat pointers" (especially C/C++). I've documented why this was important to me and my findings in [this blog post](https://codecrash.me/understanding-rust-slices). r? @lcnr
This commit is contained in:
commit
d02a209eb9
@ -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 {}
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user