mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

also update the wrapping_ docs to use similar wording

Browse Source
This commit is contained in:
Ralf Jung 2024-09-12 16:25:09 +02:00
parent 916eb130be
commit bc3d072206
2 changed files with 13 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
library/core/src/ptr/const_ptr.rs
View File

@ -420,7 +420,7 @@ pub const fn to_raw_parts(self) -> (*const (), <T as super::Pointee>::Metadata)
unsafe { self.cast::<u8>().offset(count).with_metadata_of(self) } unsafe { self.cast::<u8>().offset(count).with_metadata_of(self) }
} }
/// Calculates the offset from a pointer using wrapping arithmetic. /// Adds a signed offset to a pointer using wrapping arithmetic.
/// ///
/// `count` is in units of T; e.g., a `count` of 3 represents a pointer /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
/// offset of `3 * size_of::<T>()` bytes. /// offset of `3 * size_of::<T>()` bytes.
@ -482,7 +482,7 @@ pub const fn wrapping_offset(self, count: isize) -> *const T
unsafe { intrinsics::arith_offset(self, count) } unsafe { intrinsics::arith_offset(self, count) }
} }
/// Calculates the offset from a pointer in bytes using wrapping arithmetic. /// Adds a signed offset in bytes to a pointer using wrapping arithmetic.
/// ///
/// `count` is in units of **bytes**. /// `count` is in units of **bytes**.
/// ///
@ -972,8 +972,7 @@ pub const fn guaranteed_ne(self, other: *const T) -> Option<bool>
unsafe { self.cast::<u8>().sub(count).with_metadata_of(self) } unsafe { self.cast::<u8>().sub(count).with_metadata_of(self) }
} }
/// Calculates the offset from a pointer using wrapping arithmetic. /// Adds an unsigned offset to a pointer using wrapping arithmetic.
/// (convenience for `.wrapping_offset(count as isize)`)
/// ///
/// `count` is in units of T; e.g., a `count` of 3 represents a pointer /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
/// offset of `3 * size_of::<T>()` bytes. /// offset of `3 * size_of::<T>()` bytes.
@ -1034,8 +1033,7 @@ pub const fn wrapping_add(self, count: usize) -> Self
self.wrapping_offset(count as isize) self.wrapping_offset(count as isize)
} }
/// Calculates the offset from a pointer in bytes using wrapping arithmetic. /// Adds an unsigned offset in bytes to a pointer using wrapping arithmetic.
/// (convenience for `.wrapping_byte_offset(count as isize)`)
/// ///
/// `count` is in units of bytes. /// `count` is in units of bytes.
/// ///
@ -1053,8 +1051,7 @@ pub const fn wrapping_byte_add(self, count: usize) -> Self {
self.cast::<u8>().wrapping_add(count).with_metadata_of(self) self.cast::<u8>().wrapping_add(count).with_metadata_of(self)
} }
/// Calculates the offset from a pointer using wrapping arithmetic. /// Subtracts an unsigned offset from a pointer using wrapping arithmetic.
/// (convenience for `.wrapping_offset((count as isize).wrapping_neg())`)
/// ///
/// `count` is in units of T; e.g., a `count` of 3 represents a pointer /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
/// offset of `3 * size_of::<T>()` bytes. /// offset of `3 * size_of::<T>()` bytes.
@ -1115,8 +1112,7 @@ pub const fn wrapping_sub(self, count: usize) -> Self
self.wrapping_offset((count as isize).wrapping_neg()) self.wrapping_offset((count as isize).wrapping_neg())
} }
/// Calculates the offset from a pointer in bytes using wrapping arithmetic. /// Subtracts an unsigned offset in bytes from a pointer using wrapping arithmetic.
/// (convenience for `.wrapping_offset((count as isize).wrapping_neg())`)
/// ///
/// `count` is in units of bytes. /// `count` is in units of bytes.
/// ///

17
library/core/src/ptr/mut_ptr.rs
View File

@ -420,7 +420,8 @@ pub const fn to_raw_parts(self) -> (*mut (), <T as super::Pointee>::Metadata) {
unsafe { self.cast::<u8>().offset(count).with_metadata_of(self) } unsafe { self.cast::<u8>().offset(count).with_metadata_of(self) }
} }
/// Calculates the offset from a pointer using wrapping arithmetic. /// Adds a signed offset to a pointer using wrapping arithmetic.
///
/// `count` is in units of T; e.g., a `count` of 3 represents a pointer /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
/// offset of `3 * size_of::<T>()` bytes. /// offset of `3 * size_of::<T>()` bytes.
/// ///
@ -479,7 +480,7 @@ pub const fn wrapping_offset(self, count: isize) -> *mut T
unsafe { intrinsics::arith_offset(self, count) as *mut T } unsafe { intrinsics::arith_offset(self, count) as *mut T }
} }
/// Calculates the offset from a pointer in bytes using wrapping arithmetic. /// Adds a signed offset in bytes to a pointer using wrapping arithmetic.
/// ///
/// `count` is in units of **bytes**. /// `count` is in units of **bytes**.
/// ///
@ -1053,8 +1054,7 @@ pub const fn guaranteed_ne(self, other: *mut T) -> Option<bool>
unsafe { self.cast::<u8>().sub(count).with_metadata_of(self) } unsafe { self.cast::<u8>().sub(count).with_metadata_of(self) }
} }
/// Calculates the offset from a pointer using wrapping arithmetic. /// Adds an unsigned offset to a pointer using wrapping arithmetic.
/// (convenience for `.wrapping_offset(count as isize)`)
/// ///
/// `count` is in units of T; e.g., a `count` of 3 represents a pointer /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
/// offset of `3 * size_of::<T>()` bytes. /// offset of `3 * size_of::<T>()` bytes.
@ -1113,8 +1113,7 @@ pub const fn wrapping_add(self, count: usize) -> Self
self.wrapping_offset(count as isize) self.wrapping_offset(count as isize)
} }
/// Calculates the offset from a pointer in bytes using wrapping arithmetic. /// Adds an unsigned offset in bytes to a pointer using wrapping arithmetic.
/// (convenience for `.wrapping_byte_offset(count as isize)`)
/// ///
/// `count` is in units of bytes. /// `count` is in units of bytes.
/// ///
@ -1132,8 +1131,7 @@ pub const fn wrapping_byte_add(self, count: usize) -> Self {
self.cast::<u8>().wrapping_add(count).with_metadata_of(self) self.cast::<u8>().wrapping_add(count).with_metadata_of(self)
} }
/// Calculates the offset from a pointer using wrapping arithmetic. /// Subtracts an unsigned offset from a pointer using wrapping arithmetic.
/// (convenience for `.wrapping_offset((count as isize).wrapping_neg())`)
/// ///
/// `count` is in units of T; e.g., a `count` of 3 represents a pointer /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
/// offset of `3 * size_of::<T>()` bytes. /// offset of `3 * size_of::<T>()` bytes.
@ -1192,8 +1190,7 @@ pub const fn wrapping_sub(self, count: usize) -> Self
self.wrapping_offset((count as isize).wrapping_neg()) self.wrapping_offset((count as isize).wrapping_neg())
} }
/// Calculates the offset from a pointer in bytes using wrapping arithmetic. /// Subtracts an unsigned offset in bytes from a pointer using wrapping arithmetic.
/// (convenience for `.wrapping_offset((count as isize).wrapping_neg())`)
/// ///
/// `count` is in units of bytes. /// `count` is in units of bytes.
/// ///