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

Spell out the units used for the offset argument, so that people do

Browse Source 
not try to scale to units of bytes themselves.
This commit is contained in:
Felix S. Klock II
2013-12-16 17:07:04 +01:00
parent 7b42497453
commit 16f69b225b
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/libstd/ptr.rs
+5 -1
View File
@@ -21,7 +21,9 @@
#[cfg(not(test))] use cmp::{Eq, Ord};
/// Calculate the offset from a pointer
/// Calculate the offset from a pointer.
/// The `count` argument is in units of T; e.g. a `count` of 3
/// represents a pointer offset of `3 * sizeof::<T>()` bytes.
#[inline]
pub unsafe fn offset<T>(ptr: *T, count: int) -> *T {
intrinsics::offset(ptr, count)
@@ -29,6 +31,8 @@ pub unsafe fn offset<T>(ptr: *T, count: int) -> *T {
/// Calculate the offset from a mut pointer. The count *must* be in bounds or
/// otherwise the loads of this address are undefined.
/// The `count` argument is in units of T; e.g. a `count` of 3
/// represents a pointer offset of `3 * sizeof::<T>()` bytes.
#[inline]
pub unsafe fn mut_offset<T>(ptr: *mut T, count: int) -> *mut T {
intrinsics::offset(ptr as *T, count) as *mut T