From 47b071af2753a20c98154c47346ad1dced25b589 Mon Sep 17 00:00:00 2001 From: jbranchaud Date: Fri, 12 Dec 2014 01:18:10 -0600 Subject: [PATCH] Add doctests for `iter` and `into_iter` for BTreeSet. --- src/libcollections/btree/set.rs | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/src/libcollections/btree/set.rs b/src/libcollections/btree/set.rs index 2f9c3836604..14143498bf0 100644 --- a/src/libcollections/btree/set.rs +++ b/src/libcollections/btree/set.rs @@ -80,12 +80,38 @@ impl BTreeSet { impl BTreeSet { /// Gets an iterator over the BTreeSet's contents. + /// + /// # Examples + /// + /// ``` + /// use std::collections::BTreeSet; + /// + /// let set: BTreeSet = [1u, 2, 3, 4].iter().map(|&x| x).collect(); + /// + /// for x in set.iter() { + /// println!("{}", x); + /// } + /// + /// let v: Vec = set.iter().map(|&x| x).collect(); + /// assert_eq!(v, vec![1u,2,3,4]); + /// ``` #[unstable = "matches collection reform specification, waiting for dust to settle"] pub fn iter<'a>(&'a self) -> Items<'a, T> { self.map.keys() } /// Gets an iterator for moving out the BtreeSet's contents. + /// + /// # Examples + /// + /// ``` + /// use std::collections::BTreeSet; + /// + /// let set: BTreeSet = [1u, 2, 3, 4].iter().map(|&x| x).collect(); + /// + /// let v: Vec = set.into_iter().collect(); + /// assert_eq!(v, vec![1u,2,3,4]); + /// ``` #[unstable = "matches collection reform specification, waiting for dust to settle"] pub fn into_iter(self) -> MoveItems { self.map.into_iter().map(|(k, _)| k)