rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

doc: add Iterator::size_hint example

Browse Source
This commit is contained in:
Tshepang Lekhonkhobe
2015-08-26 22:45:32 +02:00
parent 7472886233
commit 0ca1caee93
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/libcore/iter.rs
View File

@@ -98,6 +98,13 @@ pub trait Iterator {
/// ///
/// An upper bound of `None` means either there is no known upper bound, or /// An upper bound of `None` means either there is no known upper bound, or
/// the upper bound does not fit within a `usize`. /// the upper bound does not fit within a `usize`.
///
/// # Examples
///
/// ```
/// let it = (0..10).filter(|x| x % 2 == 0).chain(15..20);
/// assert_eq!((5, Some(15)), it.size_hint());
/// ```
#[inline] #[inline]
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
fn size_hint(&self) -> (usize, Option<usize>) { (0, None) } fn size_hint(&self) -> (usize, Option<usize>) { (0, None) }