about summary refs log tree commit diff
path: root/src/libcollections
diff options
context:
space:
mode:
authorBrian Anderson <banderson@mozilla.com>2014-12-13 18:23:09 -0800
committerBrian Anderson <banderson@mozilla.com>2014-12-15 06:45:34 -0800
commit7afee3a1abb3f749b8d2a7733a0bbc3d06f6c96c (patch)
treed51d12ec4ff3d8a442f67b62de3bd7359f78bcac /src/libcollections
parente717362ce5c6a3b1c28faa19d4b61ed1a136591e (diff)
parent47b071af2753a20c98154c47346ad1dced25b589 (diff)
downloadrust-7afee3a1abb3f749b8d2a7733a0bbc3d06f6c96c.tar.gz
rust-7afee3a1abb3f749b8d2a7733a0bbc3d06f6c96c.zip
rollup merge of #19771: jbranchaud/add-btreeset-iter-doctests
Diffstat (limited to 'src/libcollections')
-rw-r--r--src/libcollections/btree/set.rs26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/libcollections/btree/set.rs b/src/libcollections/btree/set.rs
index cd01c008fe1..bca368c73e5 100644
--- a/src/libcollections/btree/set.rs
+++ b/src/libcollections/btree/set.rs
@@ -80,12 +80,38 @@ impl<T: Ord> BTreeSet<T> {
 
 impl<T> BTreeSet<T> {
     /// Gets an iterator over the BTreeSet's contents.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use std::collections::BTreeSet;
+    ///
+    /// let set: BTreeSet<uint> = [1u, 2, 3, 4].iter().map(|&x| x).collect();
+    ///
+    /// for x in set.iter() {
+    ///     println!("{}", x);
+    /// }
+    ///
+    /// let v: Vec<uint> = 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<uint> = [1u, 2, 3, 4].iter().map(|&x| x).collect();
+    ///
+    /// let v: Vec<uint> = 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<T> {
         fn first<A, B>((a, _): (A, B)) -> A { a }