Mirrors/rust
1
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2026-05-16 04:55:22 +03:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #96639 - adpaco-aws:fix-offset-from-typo, r=scottmcm

Browse Source 
Fix typo in `offset_from` documentation

Small fix for what I think is a typo in the `offset_from` documentation.

Someone reading this may understand that the distance in bytes is obtained by dividing the distance by `mem::size_of::<T>()`, but here we just want to define "units of T" in terms of bytes (i.e., units of T == bytes / `mem::size_of::<T>()`).
This commit is contained in:
Michael Goulet
2022-05-05 19:34:23 -07:00
committed by GitHub
parent 87ad928c15 9b36a47831
commit ef949daf03
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
library/core/src/ptr/const_ptr.rs
+1 -1
View File
@@ -518,7 +518,7 @@ pub const fn wrapping_offset(self, count: isize) -> *const T
}
/// Calculates the distance between two pointers. The returned value is in
/// units of T: the distance in bytes is divided by `mem::size_of::<T>()`.
/// units of T: the distance in bytes divided by `mem::size_of::<T>()`.
///
/// This function is the inverse of [`offset`].
///
library/core/src/ptr/mut_ptr.rs
+1 -1
View File
@@ -696,7 +696,7 @@ pub const fn guaranteed_eq(self, other: *mut T) -> bool
}
/// Calculates the distance between two pointers. The returned value is in
/// units of T: the distance in bytes is divided by `mem::size_of::<T>()`.
/// units of T: the distance in bytes divided by `mem::size_of::<T>()`.
///
/// This function is the inverse of [`offset`].
///