about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJake Goulding <jake.goulding@gmail.com>2015-11-03 08:25:56 -0500
committerJake Goulding <jake.goulding@gmail.com>2015-11-03 08:25:56 -0500
commitb0ca03923359afc8df92a802b7cc1476a72fb2d0 (patch)
treea902daedb7163b46e870e40185b8708a00cf0c8a
parent749625ad6d15d0254b90e3d16f79d1cb1e260969 (diff)
downloadrust-b0ca03923359afc8df92a802b7cc1476a72fb2d0.tar.gz
rust-b0ca03923359afc8df92a802b7cc1476a72fb2d0.zip
Mention what iterator terminators do with an empty iterator
-rw-r--r--src/libcore/iter.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/libcore/iter.rs b/src/libcore/iter.rs
index 262bfd5de99..c7d01b4ec2e 100644
--- a/src/libcore/iter.rs
+++ b/src/libcore/iter.rs
@@ -1565,6 +1565,8 @@ pub trait Iterator {
     /// as soon as it finds a `false`, given that no matter what else happens,
     /// the result will also be `false`.
     ///
+    /// An empty iterator returns `true`.
+    ///
     /// # Examples
     ///
     /// Basic usage:
@@ -1613,6 +1615,8 @@ pub trait Iterator {
     /// as soon as it finds a `true`, given that no matter what else happens,
     /// the result will also be `true`.
     ///
+    /// An empty iterator returns `false`.
+    ///
     /// # Examples
     ///
     /// Basic usage:
@@ -2071,6 +2075,8 @@ pub trait Iterator {
     ///
     /// Takes each element, adds them together, and returns the result.
     ///
+    /// An empty iterator returns the zero value of the type.
+    ///
     /// # Examples
     ///
     /// Basic usage:
@@ -2094,6 +2100,8 @@ pub trait Iterator {
 
     /// Iterates over the entire iterator, multiplying all the elements
     ///
+    /// An empty iterator returns the one value of the type.
+    ///
     /// # Examples
     ///
     /// ```