Skip to content

Commit 8df617e

Browse files
authored
Unrolled build for #143265
Rollup merge of #143265 - scottmcm:mention-as-chunks, r=ibraheemdev Mention as_chunks in the docs for chunks and `as_rchunks_mut` from `rchunks_exact_mut`, and such. As suggested in #76354 (comment) (but does not close that issue).
2 parents cf3fb76 + fd3161c commit 8df617e

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

library/core/src/slice/mod.rs

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1120,6 +1120,9 @@ impl<T> [T] {
11201120
/// `chunk_size` elements, and [`rchunks`] for the same iterator but starting at the end of the
11211121
/// slice.
11221122
///
1123+
/// If your `chunk_size` is a constant, consider using [`as_chunks`] instead, which will
1124+
/// give references to arrays of exactly that length, rather than slices.
1125+
///
11231126
/// # Panics
11241127
///
11251128
/// Panics if `chunk_size` is zero.
@@ -1137,6 +1140,7 @@ impl<T> [T] {
11371140
///
11381141
/// [`chunks_exact`]: slice::chunks_exact
11391142
/// [`rchunks`]: slice::rchunks
1143+
/// [`as_chunks`]: slice::as_chunks
11401144
#[stable(feature = "rust1", since = "1.0.0")]
11411145
#[rustc_const_unstable(feature = "const_slice_make_iter", issue = "137737")]
11421146
#[inline]
@@ -1156,6 +1160,9 @@ impl<T> [T] {
11561160
/// exactly `chunk_size` elements, and [`rchunks_mut`] for the same iterator but starting at
11571161
/// the end of the slice.
11581162
///
1163+
/// If your `chunk_size` is a constant, consider using [`as_chunks_mut`] instead, which will
1164+
/// give references to arrays of exactly that length, rather than slices.
1165+
///
11591166
/// # Panics
11601167
///
11611168
/// Panics if `chunk_size` is zero.
@@ -1177,6 +1184,7 @@ impl<T> [T] {
11771184
///
11781185
/// [`chunks_exact_mut`]: slice::chunks_exact_mut
11791186
/// [`rchunks_mut`]: slice::rchunks_mut
1187+
/// [`as_chunks_mut`]: slice::as_chunks_mut
11801188
#[stable(feature = "rust1", since = "1.0.0")]
11811189
#[rustc_const_unstable(feature = "const_slice_make_iter", issue = "137737")]
11821190
#[inline]
@@ -1199,6 +1207,9 @@ impl<T> [T] {
11991207
/// See [`chunks`] for a variant of this iterator that also returns the remainder as a smaller
12001208
/// chunk, and [`rchunks_exact`] for the same iterator but starting at the end of the slice.
12011209
///
1210+
/// If your `chunk_size` is a constant, consider using [`as_chunks`] instead, which will
1211+
/// give references to arrays of exactly that length, rather than slices.
1212+
///
12021213
/// # Panics
12031214
///
12041215
/// Panics if `chunk_size` is zero.
@@ -1216,6 +1227,7 @@ impl<T> [T] {
12161227
///
12171228
/// [`chunks`]: slice::chunks
12181229
/// [`rchunks_exact`]: slice::rchunks_exact
1230+
/// [`as_chunks`]: slice::chunks
12191231
#[stable(feature = "chunks_exact", since = "1.31.0")]
12201232
#[rustc_const_unstable(feature = "const_slice_make_iter", issue = "137737")]
12211233
#[inline]
@@ -1239,6 +1251,9 @@ impl<T> [T] {
12391251
/// smaller chunk, and [`rchunks_exact_mut`] for the same iterator but starting at the end of
12401252
/// the slice.
12411253
///
1254+
/// If your `chunk_size` is a constant, consider using [`as_chunks_mut`] instead, which will
1255+
/// give references to arrays of exactly that length, rather than slices.
1256+
///
12421257
/// # Panics
12431258
///
12441259
/// Panics if `chunk_size` is zero.
@@ -1260,6 +1275,7 @@ impl<T> [T] {
12601275
///
12611276
/// [`chunks_mut`]: slice::chunks_mut
12621277
/// [`rchunks_exact_mut`]: slice::rchunks_exact_mut
1278+
/// [`as_chunks_mut`]: slice::as_chunks_mut
12631279
#[stable(feature = "chunks_exact", since = "1.31.0")]
12641280
#[rustc_const_unstable(feature = "const_slice_make_iter", issue = "137737")]
12651281
#[inline]
@@ -1707,6 +1723,9 @@ impl<T> [T] {
17071723
/// `chunk_size` elements, and [`chunks`] for the same iterator but starting at the beginning
17081724
/// of the slice.
17091725
///
1726+
/// If your `chunk_size` is a constant, consider using [`as_rchunks`] instead, which will
1727+
/// give references to arrays of exactly that length, rather than slices.
1728+
///
17101729
/// # Panics
17111730
///
17121731
/// Panics if `chunk_size` is zero.
@@ -1724,6 +1743,7 @@ impl<T> [T] {
17241743
///
17251744
/// [`rchunks_exact`]: slice::rchunks_exact
17261745
/// [`chunks`]: slice::chunks
1746+
/// [`as_rchunks`]: slice::as_rchunks
17271747
#[stable(feature = "rchunks", since = "1.31.0")]
17281748
#[rustc_const_unstable(feature = "const_slice_make_iter", issue = "137737")]
17291749
#[inline]
@@ -1743,6 +1763,9 @@ impl<T> [T] {
17431763
/// exactly `chunk_size` elements, and [`chunks_mut`] for the same iterator but starting at the
17441764
/// beginning of the slice.
17451765
///
1766+
/// If your `chunk_size` is a constant, consider using [`as_rchunks_mut`] instead, which will
1767+
/// give references to arrays of exactly that length, rather than slices.
1768+
///
17461769
/// # Panics
17471770
///
17481771
/// Panics if `chunk_size` is zero.
@@ -1764,6 +1787,7 @@ impl<T> [T] {
17641787
///
17651788
/// [`rchunks_exact_mut`]: slice::rchunks_exact_mut
17661789
/// [`chunks_mut`]: slice::chunks_mut
1790+
/// [`as_rchunks_mut`]: slice::as_rchunks_mut
17671791
#[stable(feature = "rchunks", since = "1.31.0")]
17681792
#[rustc_const_unstable(feature = "const_slice_make_iter", issue = "137737")]
17691793
#[inline]
@@ -1787,6 +1811,9 @@ impl<T> [T] {
17871811
/// chunk, and [`chunks_exact`] for the same iterator but starting at the beginning of the
17881812
/// slice.
17891813
///
1814+
/// If your `chunk_size` is a constant, consider using [`as_rchunks`] instead, which will
1815+
/// give references to arrays of exactly that length, rather than slices.
1816+
///
17901817
/// # Panics
17911818
///
17921819
/// Panics if `chunk_size` is zero.
@@ -1805,6 +1832,7 @@ impl<T> [T] {
18051832
/// [`chunks`]: slice::chunks
18061833
/// [`rchunks`]: slice::rchunks
18071834
/// [`chunks_exact`]: slice::chunks_exact
1835+
/// [`as_rchunks`]: slice::as_rchunks
18081836
#[stable(feature = "rchunks", since = "1.31.0")]
18091837
#[rustc_const_unstable(feature = "const_slice_make_iter", issue = "137737")]
18101838
#[inline]
@@ -1828,6 +1856,9 @@ impl<T> [T] {
18281856
/// smaller chunk, and [`chunks_exact_mut`] for the same iterator but starting at the beginning
18291857
/// of the slice.
18301858
///
1859+
/// If your `chunk_size` is a constant, consider using [`as_rchunks_mut`] instead, which will
1860+
/// give references to arrays of exactly that length, rather than slices.
1861+
///
18311862
/// # Panics
18321863
///
18331864
/// Panics if `chunk_size` is zero.
@@ -1850,6 +1881,7 @@ impl<T> [T] {
18501881
/// [`chunks_mut`]: slice::chunks_mut
18511882
/// [`rchunks_mut`]: slice::rchunks_mut
18521883
/// [`chunks_exact_mut`]: slice::chunks_exact_mut
1884+
/// [`as_rchunks_mut`]: slice::as_rchunks_mut
18531885
#[stable(feature = "rchunks", since = "1.31.0")]
18541886
#[rustc_const_unstable(feature = "const_slice_make_iter", issue = "137737")]
18551887
#[inline]

0 commit comments

Comments
 (0)