Merge #11

11: Prepare 0.4.0 release r=jix a=jix



Co-authored-by: Jannis Harder <me@jix.one>

.proteto/README.md

@@ -2,15 +2,19 @@
 %% block body
 Forward scan over a vector with mutation and item removal.
 
-Provides an iterator like interface over a vector which allows mutation and
-removal of items. Items are kept in order and every item is moved at most once,
-even when items are removed. Dropping the `VecMutScan` mid-iteration keeps
-remaining items in the vector.
+Provides a `VecMutScan` wrapper for a `Vec` with an iterator like interface
+over which also allows mutation and removal of items. Items are kept in order
+and every item is moved at most once, even when items are removed. Dropping the
+`VecMutScan` mid-iteration keeps remaining items in the vector.
 
 This can be seen as an extension of `Vec`'s `retain` and `drain`. It is also
 very similar to the unstable `drain_filter` but slightly more flexible. Unlike
 `drain_filter` this specifies the drop behavior (to keep all following
 elements). It also doesn't require the filtering to be done within a closure,
 which gives additional flexibilty at the cost of not being able to implement
 the `Iterator` trait.
+
+Also provides a `VecGrowScan` wrapper that extends `VecMutScan` to allow
+insertions during the iteration. This may require additional item moves and
+temporary storage, but still runs in linear time.
 %% endblock

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## vec_mut_scan 0.4.0 (2021-01-17)
+
+* Add `VecGrowScan` for arbitrary insertions and removals during iteration (contributed by Jakub Kądziołka)
+
 ## vec_mut_scan 0.3.0 (2020-09-08)
 
 * Allow mutable access to all vector elements during iteration

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vec_mut_scan"
-version = "0.3.0"
+version = "0.4.0"
 authors = ["Jannis Harder <me@jix.one>"]
 edition = "2018"
 description = "Forward scan over a vector with mutation and item removal"

README.md

@@ -7,10 +7,10 @@
 
 Forward scan over a vector with mutation and item removal.
 
-Provides an iterator like interface over a vector which allows mutation and
-removal of items. Items are kept in order and every item is moved at most once,
-even when items are removed. Dropping the `VecMutScan` mid-iteration keeps
-remaining items in the vector.
+Provides a `VecMutScan` wrapper for a `Vec` with an iterator like interface
+over which also allows mutation and removal of items. Items are kept in order
+and every item is moved at most once, even when items are removed. Dropping the
+`VecMutScan` mid-iteration keeps remaining items in the vector.
 
 This can be seen as an extension of `Vec`'s `retain` and `drain`. It is also
 very similar to the unstable `drain_filter` but slightly more flexible. Unlike
@@ -19,6 +19,10 @@ elements). It also doesn't require the filtering to be done within a closure,
 which gives additional flexibilty at the cost of not being able to implement
 the `Iterator` trait.
 
+Also provides a `VecGrowScan` wrapper that extends `VecMutScan` to allow
+insertions during the iteration. This may require additional item moves and
+temporary storage, but still runs in linear time.
+
 ## License
 
 This software is available under the Zero-Clause BSD license, see