-
Notifications
You must be signed in to change notification settings - Fork 12.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Iterator::find_map #49098
Add Iterator::find_map #49098
Conversation
r? @KodrAus (rust_highfive has picked a reviewer for you, use r? to override) |
I think I'm for this PR, but a small note re:
I think given the latest |
Instead of adding iterators randomly, I suggest to take a look at the most commonly used iterators from the itertools crate, and add those. |
There's nothing random about this addition - I think it is right to fill consistency holes per @matklad's table above. That said, we should add some operations from |
By "randomly" I meant: "not needed in lot of code by lot of people". I agree it's hard to measure this need exactly, but even measuring it approximately is OK. I have written a ton of iterator-based Rust/Python/D code and I think there are things (much) more useful than a find_map. Regarding the "most useful itertools things", I can give you a list, but probably every programmer has a slightly different list. In my opinion the intersection of such lists is far from empty. I think this topic is better discussed in a forum thread than here. |
Please do =) (and also discount things that require allocation, because those can't be in libcore) |
@leonardo-m I totally agree that “how often is this used in practice” should be one of the primarily axis along which to measure additions to std. That’s why I’ve tried to measure how often could find_map be used in practice, by giving examples of real-life code :)
Keep in mind that what kinds of iterators you need most highly depends on the kind of code you are writing. For me, find_map is the second most important missing method at the moment (the first one is join of course, producing a comma separated list of things in Rust is ridiculously not straight forward at the moment) |
Ping from triage, @KodrAus ! Will you have time to review this soon? |
This particular cc @rust-lang/libs any thoughts on |
Pushed some tests! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @matklad! I think this has been sitting around long enough. Once we have the unstable issue number sorted I think this will be ready to go.
src/libcore/iter/iterator.rs
Outdated
#[inline] | ||
#[unstable(feature = "iterator_find_map", | ||
reason = "unstable new API", | ||
issue = "0")] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've created a tracking issue so we can update the value here. The issue is #49602
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Filled in the issue number!
@bors r+ |
📌 Commit 591dd5d has been approved by |
Add Iterator::find_map I'd like to propose to add `find_map` method to the `Iterator`: an occasionally useful utility, which relates to `filter_map` in the same way that `find` relates to `filter`. `find_map` takes an `Option`-returning function, applies it to the elements of the iterator, and returns the first non-`None` result. In other words, `find_map(f) == filter_map(f).next()`. Why do we want to add a function to the `Iterator`, which can be trivially expressed as a combination of existing ones? Observe that `find(f) == filter(f).next()`, so, by the same logic, `find` itself is unnecessary! The more positive argument is that desugaring of `find[_map]` in terms of `filter[_map]().next()` is not super obvious, because the `filter` operation reads as if it is applies to the whole collection, although in reality we are interested only in the first element. That is, the jump from "I need a **single** result" to "let's use a function which maps **many** values to **many** values" is a non-trivial speed-bump, and causes friction when reading and writing code. Does the need for `find_map` arise in practice? Yes! * Anecdotally, I've more than once searched the docs for the function with `[T] -> (T -> Option<U>) -> Option<U>` signature. * The direct cause for this PR was [this](https://github.com/rust-lang/cargo/pull/5187/files/1291c50e86ed4b31db0c76de03a47a5d0074bbd7#r174934173) discussion in Cargo, which boils down to "there's some pattern that we try to express here, but current approaches looks non-pretty" (and the pattern is `filter_map` * There are several `filter_map().next` combos in Cargo: [[1]](https://github.com/rust-lang/cargo/blob/545a4a2c930916cc9c3dc1716fb7a33299e4062b/src/cargo/ops/cargo_new.rs#L585), [[2]](https://github.com/rust-lang/cargo/blob/545a4a2c930916cc9c3dc1716fb7a33299e4062b/src/cargo/core/resolver/mod.rs#L1130), [[3]](https://github.com/rust-lang/cargo/blob/545a4a2c930916cc9c3dc1716fb7a33299e4062b/src/cargo/ops/cargo_rustc/mod.rs#L1086). * I've also needed similar functionality in `Kotlin` several times. There, it is expressed as `mapNotNull {}.firstOrNull`, as can be seen [here](https://github.com/intellij-rust/intellij-rust/blob/ee8bdb4e073fd07142fc6e1853ca288c57495e69/src/main/kotlin/org/rust/cargo/project/model/impl/CargoProjectImpl.kt#L154), [here](https://github.com/intellij-rust/intellij-rust/blob/ee8bdb4e073fd07142fc6e1853ca288c57495e69/src/main/kotlin/org/rust/lang/core/resolve/ImplLookup.kt#L444) [here](https://github.com/intellij-rust/intellij-rust/blob/ee8bdb4e073fd07142fc6e1853ca288c57495e69/src/main/kotlin/org/rust/ide/inspections/RsLint.kt#L38) and [here](https://github.com/intellij-rust/intellij-rust/blob/ee8bdb4e073fd07142fc6e1853ca288c57495e69/src/main/kotlin/org/rust/cargo/toolchain/RustToolchain.kt#L74) (and maybe in some other cases as well) Note that it is definitely not among the most popular functions (it definitely is less popular than `find`), but, for example it (in case of Cargo) seems to be more popular than `rposition` (1 occurrence), `step_by` (zero occurrences) and `nth` (three occurrences as `nth(0)` which probably should be replaced with `next`). Do we necessary need this function in `std`? Could we move it to itertools? That is possible, but observe that `filter`, `filter_map`, `find` and `find_map` together really form a complete table: ||| |-------|---------| | filter| find| |filter_map|find_map| It would be somewhat unsatisfying to have one quarter of this table live elsewhere :) Also, if `Itertools` adds an `find_map` method, it would be more difficult to move it to std due to name collision. Hm, at this point I've searched for `filter_map` the umpteenth time, and, strangely, this time I do find this RFC: rust-lang/rfcs#1801. I guess this could be an implementation though? :) To sum up: Pro: - complete the symmetry with existing method - codify a somewhat common non-obvious pattern Contra: - niche use case - we can, and do, live without it
☀️ Test successful - status-appveyor, status-travis |
/// #![feature(iterator_find_map)] | ||
/// let a = ["lol", "NaN", "2", "5"]; | ||
/// | ||
/// let mut first_number = a.iter().find_map(|s| s.parse().ok()); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The mut
is not needed here, I believe.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@meven seems plausible — submit a PR to fix it, please?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR opened at #55389
Remove unnecessary mut in iterator.find_map documentation example, R… Relates to rust-lang#49098 Removes a mut that could induce newcomers to put a mut in their code that the compiler would comply about. https://github.com/rust-lang/rust/pull/49098/files#r227422388
Remove unnecessary mut in iterator.find_map documentation example, R… Relates to rust-lang#49098 Removes a mut that could induce newcomers to put a mut in their code that the compiler would comply about. https://github.com/rust-lang/rust/pull/49098/files#r227422388
I'd like to propose to add
find_map
method to theIterator
: an occasionally useful utility, which relates tofilter_map
in the same way thatfind
relates tofilter
.find_map
takes anOption
-returning function, applies it to the elements of the iterator, and returns the first non-None
result. In other words,find_map(f) == filter_map(f).next()
.Why do we want to add a function to the
Iterator
, which can be trivially expressed as a combination of existing ones? Observe thatfind(f) == filter(f).next()
, so, by the same logic,find
itself is unnecessary!The more positive argument is that desugaring of
find[_map]
in terms offilter[_map]().next()
is not super obvious, because thefilter
operation reads as if it is applies to the whole collection, although in reality we are interested only in the first element. That is, the jump from "I need a single result" to "let's use a function which maps many values to many values" is a non-trivial speed-bump, and causes friction when reading and writing code.Does the need for
find_map
arise in practice? Yes![T] -> (T -> Option<U>) -> Option<U>
signature.filter_map
filter_map().next
combos in Cargo: [1], [2], [3].Kotlin
several times. There, it is expressed asmapNotNull {}.firstOrNull
, as can be seen here, here here and here (and maybe in some other cases as well)Note that it is definitely not among the most popular functions (it definitely is less popular than
find
), but, for example it (in case of Cargo) seems to be more popular thanrposition
(1 occurrence),step_by
(zero occurrences) andnth
(three occurrences asnth(0)
which probably should be replaced withnext
).Do we necessary need this function in
std
? Could we move it to itertools? That is possible, but observe thatfilter
,filter_map
,find
andfind_map
together really form a complete table:It would be somewhat unsatisfying to have one quarter of this table live elsewhere :) Also, if
Itertools
adds anfind_map
method, it would be more difficult to move it to std due to name collision.Hm, at this point I've searched for
filter_map
the umpteenth time, and, strangely, this time I do find this RFC: rust-lang/rfcs#1801. I guess this could be an implementation though? :)To sum up:
Pro:
Contra: