docs: Changed docs for size_of to describe size as a stride offset

Current description of `std::mem::size_of` is ambiguous, and the
`std::intrinsics::size_of` description incorrectly defines size
as the number of bytes necessary to exactly overwrite a value,
not including the padding between elements necessary in a vector
or structure.
This commit is contained in:
Taylor Cramer 2016-05-01 23:30:12 -07:00
parent 855fb61922
commit 38c8836051
2 changed files with 5 additions and 5 deletions

View File

@ -192,11 +192,8 @@ extern "rust-intrinsic" {
/// The size of a type in bytes.
///
/// This is the exact number of bytes in memory taken up by a
/// value of the given type. In other words, a memset of this size
/// would *exactly* overwrite a value. When laid out in vectors
/// and structures there may be additional padding between
/// elements.
/// More specifically, this is the offset in bytes between successive
/// items of the same type, including alignment padding.
pub fn size_of<T>() -> usize;
/// Moves a value to an uninitialized memory location.

View File

@ -117,6 +117,9 @@ pub fn forget<T>(t: T) {
/// Returns the size of a type in bytes.
///
/// More specifically, this is the offset in bytes between successive
/// items of the same type, including alignment padding.
///
/// # Examples
///
/// ```