about summary refs log tree commit diff
path: root/library/alloc/src/string.rs
diff options
context:
space:
mode:
authorJosh Stone <jistone@redhat.com>2021-07-28 16:35:59 -0700
committerJosh Stone <jistone@redhat.com>2021-07-28 16:35:59 -0700
commitd4a60ab34f4f612365e353fafdfb4e28f1484e47 (patch)
tree907bb2e0a5b1b25818eb7745f8bd3fbaf998e3da /library/alloc/src/string.rs
parentb70888601af92f6cdc0364abab3446e418b91d36 (diff)
downloadrust-d4a60ab34f4f612365e353fafdfb4e28f1484e47.tar.gz
rust-d4a60ab34f4f612365e353fafdfb4e28f1484e47.zip
Update the examples in `String` and `VecDeque::retain`
The examples added in #60396 used a "clever" post-increment hack,
unrelated to the actual point of the examples. That hack was found
[confusing] in the users forum, and #81811 already changed the `Vec`
example to use a more direct iterator. This commit changes `String` and
`VecDeque` in the same way for consistency.

[confusing]: https://users.rust-lang.org/t/help-understand-strange-expression/62858
Diffstat (limited to 'library/alloc/src/string.rs')
-rw-r--r--library/alloc/src/string.rs7
1 files changed, 4 insertions, 3 deletions
diff --git a/library/alloc/src/string.rs b/library/alloc/src/string.rs
index 0d8678291be..6a02de7f9a2 100644
--- a/library/alloc/src/string.rs
+++ b/library/alloc/src/string.rs
@@ -1350,13 +1350,14 @@ impl String {
     /// assert_eq!(s, "foobar");
     /// ```
     ///
-    /// The exact order may be useful for tracking external state, like an index.
+    /// Because the elements are visited exactly once in the original order,
+    /// external state may be used to decide which elements to keep.
     ///
     /// ```
     /// let mut s = String::from("abcde");
     /// let keep = [false, true, true, false, true];
-    /// let mut i = 0;
-    /// s.retain(|_| (keep[i], i += 1).0);
+    /// let mut iter = keep.iter();
+    /// s.retain(|_| *iter.next().unwrap());
     /// assert_eq!(s, "bce");
     /// ```
     #[inline]