about summary refs log tree commit diff
diff options
context:
space:
mode:
authorjbranchaud <jbranchaud@gmail.com>2014-12-09 22:08:44 -0600
committerjbranchaud <jbranchaud@gmail.com>2014-12-09 22:19:23 -0600
commitd946426699c8316d587cc382c8a2e7030b53aed5 (patch)
tree53cf7ab2200b3dea395f7cea472d40a1060a8581
parent4c692d3a35945d434c576c048d7066d961831980 (diff)
downloadrust-d946426699c8316d587cc382c8a2e7030b53aed5.tar.gz
rust-d946426699c8316d587cc382c8a2e7030b53aed5.zip
Add doctests for `iter_mut` and `into_iter` of BTreeMap.
Add spacing as dictated by standard rust code style.
-rw-r--r--src/libcollections/btree/map.rs33
1 files changed, 33 insertions, 0 deletions
diff --git a/src/libcollections/btree/map.rs b/src/libcollections/btree/map.rs
index 86eaa04b3e2..51d64e2dba5 100644
--- a/src/libcollections/btree/map.rs
+++ b/src/libcollections/btree/map.rs
@@ -1058,6 +1058,24 @@ impl<K, V> BTreeMap<K, V> {
     }
 
     /// Gets a mutable iterator over the entries of the map.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use std::collections::BTreeMap;
+    ///
+    /// let mut map = BTreeMap::new();
+    /// map.insert("a", 1u);
+    /// map.insert("b", 2u);
+    /// map.insert("c", 3u);
+    ///
+    /// // add 10 to the value if the key isn't "a"
+    /// for (key, value) in map.iter_mut() {
+    ///     if key != &"a" {
+    ///         *value += 10;
+    ///     }
+    /// }
+    /// ```
     #[unstable = "matches collection reform specification, waiting for dust to settle"]
     pub fn iter_mut<'a>(&'a mut self) -> MutEntries<'a, K, V> {
         let len = self.len();
@@ -1072,6 +1090,21 @@ impl<K, V> BTreeMap<K, V> {
     }
 
     /// Gets an owning iterator over the entries of the map.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use std::collections::BTreeMap;
+    ///
+    /// let mut map = BTreeMap::new();
+    /// map.insert(1u, "a");
+    /// map.insert(2u, "b");
+    /// map.insert(3u, "c");
+    ///
+    /// for (key, value) in map.into_iter() {
+    ///     println!("{}: {}", key, value);
+    /// }
+    /// ```
     #[unstable = "matches collection reform specification, waiting for dust to settle"]
     pub fn into_iter(self) -> MoveEntries<K, V> {
         let len = self.len();