about summary refs log tree commit diff
path: root/src/libcore/iter
diff options
context:
space:
mode:
authorMatthias Krüger <matthias.krueger@famsik.de>2020-02-27 00:35:04 +0100
committerMatthias Krüger <matthias.krueger@famsik.de>2020-02-27 15:08:21 +0100
commit31b9764a14f1cd2c4caeb178ef091334fd89d2ee (patch)
tree4b9a1e320388713ade42d5d92930227d4bc0a461 /src/libcore/iter
parenta8437cf213ac1e950b6f5c691c4d2a29bf949bcd (diff)
downloadrust-31b9764a14f1cd2c4caeb178ef091334fd89d2ee.tar.gz
rust-31b9764a14f1cd2c4caeb178ef091334fd89d2ee.zip
docs: note that find(f) is equivalent to filter(f).next() in the iterator docs.
Diffstat (limited to 'src/libcore/iter')
-rw-r--r--src/libcore/iter/traits/iterator.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/libcore/iter/traits/iterator.rs b/src/libcore/iter/traits/iterator.rs
index 1d055676c77..6a529bfc8df 100644
--- a/src/libcore/iter/traits/iterator.rs
+++ b/src/libcore/iter/traits/iterator.rs
@@ -719,6 +719,8 @@ pub trait Iterator {
     /// ```
     ///
     /// of these layers.
+    ///
+    /// Note that `iter.filter(f).next()` is equivalent to `iter.find(f)`.
     #[inline]
     #[stable(feature = "rust1", since = "1.0.0")]
     fn filter<P>(self, predicate: P) -> Filter<Self, P>
@@ -2152,6 +2154,8 @@ pub trait Iterator {
     /// // we can still use `iter`, as there are more elements.
     /// assert_eq!(iter.next(), Some(&3));
     /// ```
+    ///
+    /// Note that `iter.find(f)` is equivalent to `iter.filter(f).next()`.
     #[inline]
     #[stable(feature = "rust1", since = "1.0.0")]
     fn find<P>(&mut self, predicate: P) -> Option<Self::Item>