bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Indicate that BTreeSet::iter returns values in ascending order.

Browse source 
Fixes https://github.com/rust-lang/rust/issues/38204.
This commit is contained in:
Corey Farwell 2016-12-06 15:47:33 -10:00
parent 4c4e8c4af7
commit fe0d0927f7
1 changed files with 14 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

15
src/libcollections/btree/set.rs
View file

@ -173,7 +173,7 @@ impl<T: Ord> BTreeSet<T> {
}
impl<T> BTreeSet<T> {
/// Gets an iterator over the `BTreeSet`'s contents.
/// Gets an iterator that visits the values in the `BTreeSet` in ascending order.
///
/// # Examples
///
@ -187,6 +187,19 @@ impl<T> BTreeSet<T> {
/// assert_eq!(set_iter.next(), Some(&3));
/// assert_eq!(set_iter.next(), None);
/// ```
///
/// Values returned by the iterator are returned in ascending order:
///
/// ```
/// use std::collections::BTreeSet;
///
/// let set: BTreeSet<usize> = [3, 1, 2].iter().cloned().collect();
/// let mut set_iter = set.iter();
/// assert_eq!(set_iter.next(), Some(&1));
/// assert_eq!(set_iter.next(), Some(&2));
/// assert_eq!(set_iter.next(), Some(&3));
/// assert_eq!(set_iter.next(), None);
/// ```
#[stable(feature = "rust1", since = "1.0.0")]
pub fn iter(&self) -> Iter<T> {
Iter { iter: self.map.keys() }