Skip to content

Commit a06508a

Browse files
committed
Merge pull request #19771 from jbranchaud/add-btreeset-iter-doctests
Add doctests for `iter` and `into_iter` for BTreeSet. Reviewed-by: steveklabnik
2 parents b5fbfe2 + 47b071a commit a06508a

File tree

1 file changed

+26
-0
lines changed
  • src/libcollections/btree

1 file changed

+26
-0
lines changed

src/libcollections/btree/set.rs

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,38 @@ impl<T: Ord> BTreeSet<T> {
8383

8484
impl<T> BTreeSet<T> {
8585
/// Gets an iterator over the BTreeSet's contents.
86+
///
87+
/// # Examples
88+
///
89+
/// ```
90+
/// use std::collections::BTreeSet;
91+
///
92+
/// let set: BTreeSet<uint> = [1u, 2, 3, 4].iter().map(|&x| x).collect();
93+
///
94+
/// for x in set.iter() {
95+
/// println!("{}", x);
96+
/// }
97+
///
98+
/// let v: Vec<uint> = set.iter().map(|&x| x).collect();
99+
/// assert_eq!(v, vec![1u,2,3,4]);
100+
/// ```
86101
#[unstable = "matches collection reform specification, waiting for dust to settle"]
87102
pub fn iter<'a>(&'a self) -> Items<'a, T> {
88103
Items { iter: self.map.keys() }
89104
}
90105

91106
/// Gets an iterator for moving out the BtreeSet's contents.
107+
///
108+
/// # Examples
109+
///
110+
/// ```
111+
/// use std::collections::BTreeSet;
112+
///
113+
/// let set: BTreeSet<uint> = [1u, 2, 3, 4].iter().map(|&x| x).collect();
114+
///
115+
/// let v: Vec<uint> = set.into_iter().collect();
116+
/// assert_eq!(v, vec![1u,2,3,4]);
117+
/// ```
92118
#[unstable = "matches collection reform specification, waiting for dust to settle"]
93119
pub fn into_iter(self) -> MoveItems<T> {
94120
fn first<A, B>((a, _): (A, B)) -> A { a }

0 commit comments

Comments
 (0)