Rollup merge of #127422 - greaka:master, r=workingjubilee

as_simd: fix doc comment to be in line with align_to In #121201, the guarantees about `align_offset` and `align_to` were changed. This PR aims to correct the doc comment of `as_simd` to be in line with the new `align_to`. Tagging #86656 for good measure.
rust-lang · Jul 12, 2024 · 1e7ad4c · 1e7ad4c
2 parents 58fe37f 585ca16
commit 1e7ad4c
Showing 1 changed file with 4 additions and 22 deletions.
diff --git a/library/core/src/slice/mod.rs b/library/core/src/slice/mod.rs
@@ -3959,17 3959,8 @@ impl<T> [T] {
 
  /// Split a slice into a prefix, a middle of aligned SIMD types, and a suffix.
  ///
- /// This is a safe wrapper around [`slice::align_to`], so has the same weak
- /// postconditions as that method. You're only assured that
- /// `self.len() == prefix.len() middle.len() * LANES suffix.len()`.
- ///
- /// Notably, all of the following are possible:
- /// - `prefix.len() >= LANES`.
- /// - `middle.is_empty()` despite `self.len() >= 3 * LANES`.
- /// - `suffix.len() >= LANES`.
- ///
- /// That said, this is a safe method, so if you're only writing safe code,
- /// then this can at most cause incorrect logic, not unsoundness.
  /// This is a safe wrapper around [`slice::align_to`], so inherits the same
  /// guarantees as that method.
  ///
  /// # Panics
  ///
@@ -4033,17 4024,8 @@ impl<T> [T] {
  /// Split a mutable slice into a mutable prefix, a middle of aligned SIMD types,
  /// and a mutable suffix.
  ///
- /// This is a safe wrapper around [`slice::align_to_mut`], so has the same weak
- /// postconditions as that method. You're only assured that
- /// `self.len() == prefix.len() middle.len() * LANES suffix.len()`.
- ///
- /// Notably, all of the following are possible:
- /// - `prefix.len() >= LANES`.
- /// - `middle.is_empty()` despite `self.len() >= 3 * LANES`.
- /// - `suffix.len() >= LANES`.
- ///
- /// That said, this is a safe method, so if you're only writing safe code,
- /// then this can at most cause incorrect logic, not unsoundness.
  /// This is a safe wrapper around [`slice::align_to_mut`], so inherits the same
  /// guarantees as that method.
  ///
  /// This is the mutable version of [`slice::as_simd`]; see that for examples.
  ///