]> git.lizzy.rs Git - rust.git/commitdiff
Add doc(hidden) to all __iterator_get_unchecked
authorJacob Hoffman-Andrews <github@hoffman-andrews.com>
Sat, 12 Jun 2021 05:16:44 +0000 (22:16 -0700)
committerJacob Hoffman-Andrews <github@hoffman-andrews.com>
Thu, 17 Jun 2021 05:08:44 +0000 (22:08 -0700)
This method on the Iterator trait is doc(hidden), and about half of
implementations were doc(hidden). This adds the attribute to the
remaining implementations.

14 files changed:
library/alloc/src/collections/vec_deque/into_iter.rs
library/alloc/src/collections/vec_deque/iter.rs
library/alloc/src/collections/vec_deque/iter_mut.rs
library/alloc/src/vec/into_iter.rs
library/core/src/array/iter.rs
library/core/src/iter/adapters/cloned.rs
library/core/src/iter/adapters/copied.rs
library/core/src/iter/adapters/enumerate.rs
library/core/src/iter/adapters/fuse.rs
library/core/src/iter/adapters/map.rs
library/core/src/iter/adapters/zip.rs
library/core/src/iter/range.rs
library/core/src/slice/iter.rs
library/core/src/str/iter.rs

index 1c635dd4f27fa8c001cfc5287f2ccf0ff45ad952..46a769a722a8bf3ce44873eb25186e63d3e84c7f 100644 (file)
@@ -38,6 +38,7 @@ fn size_hint(&self) -> (usize, Option<usize>) {
     }
 
     #[inline]
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, idx: usize) -> Self::Item
     where
         Self: TrustedRandomAccess,
index f3eb228c9e3802dab098de5d886dc79f8e7901c1..ae1b03c9a4d2247b4a201135c4e82ac18c807e0e 100644 (file)
@@ -103,6 +103,7 @@ fn last(mut self) -> Option<&'a T> {
     }
 
     #[inline]
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, idx: usize) -> Self::Item
     where
         Self: TrustedRandomAccess,
index 9493676e66bc8f3232e6937aea62a6a99a47a38a..df30c38652f72ef0ea100e31ba6110883c992592 100644 (file)
@@ -89,6 +89,7 @@ fn last(mut self) -> Option<&'a mut T> {
     }
 
     #[inline]
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, idx: usize) -> Self::Item
     where
         Self: TrustedRandomAccess,
index 8da4d995ba5c66094dbfb45a431f7bd720fc96c4..7a08f4c6cbaaceba1f983cc6be2cb116aae54c4c 100644 (file)
@@ -163,6 +163,7 @@ fn count(self) -> usize {
         self.len()
     }
 
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, i: usize) -> Self::Item
     where
         Self: TrustedRandomAccess,
index aedbeab661058bf7f2953713e118fd272b907693..931ea77eca4dc4c1bff749d1f489cd259fe63eef 100644 (file)
@@ -132,6 +132,7 @@ fn last(mut self) -> Option<Self::Item> {
     }
 
     #[inline]
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, idx: usize) -> Self::Item
     where
         Self: TrustedRandomAccess,
index 7efc155175c34f8c2d4ad0d73cc2e8654562400e..5cd65a9415fd7d2ba553488a3bcec266cedd0fae 100644 (file)
@@ -58,6 +58,7 @@ fn fold<Acc, F>(self, init: Acc, f: F) -> Acc
         self.it.map(T::clone).fold(init, f)
     }
 
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, idx: usize) -> T
     where
         Self: TrustedRandomAccess,
index def2408927589de601c5c9e246e06e39f78b2cfd..07a3b5d245659ec18da4b5fcbcf71eb5b5a9a8f9 100644 (file)
@@ -74,6 +74,7 @@ fn count(self) -> usize {
         self.it.count()
     }
 
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, idx: usize) -> T
     where
         Self: TrustedRandomAccess,
index 91722a4b62a2e86ca5c0f5712cea4a5a6caee99e..8b27bdc60a7055aff561a716c22ba9c7d77e967b 100644 (file)
@@ -111,6 +111,7 @@ fn enumerate<T, Acc>(
     }
 
     #[rustc_inherit_overflow_checks]
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, idx: usize) -> <Self as Iterator>::Item
     where
         Self: TrustedRandomAccess,
index aff48b1b220c411ce645cce1aafee5d777b0af61..0c21df4f12c60c167f291508d8947f7343abc322 100644 (file)
@@ -114,6 +114,7 @@ fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
     }
 
     #[inline]
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, idx: usize) -> Self::Item
     where
         Self: TrustedRandomAccess,
index 0bf9f4b0327e969cb16225a842e61ad1a3ad9b39..dc86eccfcb82f36c700936a058823a59265c15a3 100644 (file)
@@ -122,6 +122,7 @@ fn fold<Acc, G>(self, init: Acc, g: G) -> Acc
         self.iter.fold(init, map_fold(self.f, g))
     }
 
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, idx: usize) -> B
     where
         Self: TrustedRandomAccess,
index c95324c80ba61e14243b3fc59e8ed6c5fc2ca605..8a6955060e82fd2e8322e63df5f55de592a23647 100644 (file)
@@ -88,6 +88,7 @@ fn nth(&mut self, n: usize) -> Option<Self::Item> {
     }
 
     #[inline]
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, idx: usize) -> Self::Item
     where
         Self: TrustedRandomAccess,
index de5d77e96ee568b98be6e79864600d47ae7147ab..4a86d6a100abe66539a41037cfe2de4db9dbb9cd 100644 (file)
@@ -667,6 +667,7 @@ fn max(mut self) -> Option<A> {
     }
 
     #[inline]
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, idx: usize) -> Self::Item
     where
         Self: TrustedRandomAccess,
index 1ee662c6c8e3cc60938552e7bd71913abe91e833..b2cb2f12bbfeb83d6797a93de8b68804e6e3feaf 100644 (file)
@@ -2148,6 +2148,7 @@ fn last(self) -> Option<Self::Item> {
         self.iter.last()
     }
 
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, i: usize) -> &'a [T; N] {
         // SAFETY: The safety guarantees of `__iterator_get_unchecked` are
         // transferred to the caller.
@@ -2260,6 +2261,7 @@ fn last(self) -> Option<Self::Item> {
         self.iter.last()
     }
 
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, i: usize) -> &'a mut [T; N] {
         // SAFETY: The safety guarantees of `__iterator_get_unchecked` are transferred to
         // the caller.
index 6ec6b70b57119b863e3788ef107705f3b8d54c75..a5774764573be4143193b4e4d994379da39bc8fe 100644 (file)
@@ -295,6 +295,7 @@ fn rposition<P>(&mut self, predicate: P) -> Option<usize>
     }
 
     #[inline]
+    #[doc(hidden)]
     unsafe fn __iterator_get_unchecked(&mut self, idx: usize) -> u8 {
         // SAFETY: the caller must uphold the safety contract
         // for `Iterator::__iterator_get_unchecked`.