vec_mut_scan 0.5.0

Forward scan over a vector with mutation and item removal
Documentation
  • Coverage
  • 100%
    30 out of 30 items documented1 out of 29 items with examples
  • Size
  • Source code size: 44.36 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 2.32 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 10s Average build duration of successful builds.
  • all releases: 10s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • jix/vec_mut_scan
    2 4 0
  • crates.io
  • Dependencies
    • —
  • Versions
  • Owners
  • jix

vec_mut_scan

github crates.io docs.rs

Forward scan over a vector with mutation and item removal.

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.

License

This software is available under the Zero-Clause BSD license, see COPYRIGHT for full licensing information and exceptions to this.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this software by you shall be licensed as defined in COPYRIGHT.