diff options
| author | LeSeulArtichaut <leseulartichaut@gmail.com> | 2020-02-16 17:12:26 +0100 |
|---|---|---|
| committer | LeSeulArtichaut <leseulartichaut@gmail.com> | 2020-02-16 17:12:26 +0100 |
| commit | 0891496898423bd03227a27492816ef56319d95c (patch) | |
| tree | 3d380cb63b2cc67e1f945b785dddfea7522f76d5 | |
| parent | 8040bc983669fcc3fe358dfc9772ea2ecde0ae1b (diff) | |
| download | rust-0891496898423bd03227a27492816ef56319d95c.tar.gz rust-0891496898423bd03227a27492816ef56319d95c.zip | |
Improve documentation on iterators
| -rw-r--r-- | src/libcore/iter/mod.rs | 3 | ||||
| -rw-r--r-- | src/libcore/iter/traits/exact_size.rs | 3 |
2 files changed, 4 insertions, 2 deletions
diff --git a/src/libcore/iter/mod.rs b/src/libcore/iter/mod.rs index 5fa9962f811..080b70c6368 100644 --- a/src/libcore/iter/mod.rs +++ b/src/libcore/iter/mod.rs @@ -43,7 +43,7 @@ //! are elements, and once they've all been exhausted, will return `None` to //! indicate that iteration is finished. Individual iterators may choose to //! resume iteration, and so calling [`next`] again may or may not eventually -//! start returning `Some(Item)` again at some point. +//! start returning `Some(Item)` again at some point (for example, see [`TryIter`]). //! //! [`Iterator`]'s full definition includes a number of other methods as well, //! but they are default methods, built on top of [`next`], and so you get @@ -56,6 +56,7 @@ //! [`Iterator`]: trait.Iterator.html //! [`next`]: trait.Iterator.html#tymethod.next //! [`Option`]: ../../std/option/enum.Option.html +//! [`TryIter`]: ../../std/sync/mpsc/struct.TryIter.html //! //! # The three forms of iteration //! diff --git a/src/libcore/iter/traits/exact_size.rs b/src/libcore/iter/traits/exact_size.rs index 4a7db348b18..946c3f85824 100644 --- a/src/libcore/iter/traits/exact_size.rs +++ b/src/libcore/iter/traits/exact_size.rs @@ -69,7 +69,8 @@ /// ``` #[stable(feature = "rust1", since = "1.0.0")] pub trait ExactSizeIterator: Iterator { - /// Returns the exact number of times the iterator will iterate. + /// Returns the exact length of the iterator, which is the number of times + /// the iterator will return `Some(T)` before returning `None`. /// /// This method has a default implementation, so you usually should not /// implement it directly. However, if you can provide a more efficient |
