Skip to content

Commit f57a710

Browse files
committed
Fix rust-lang#1261: document Iterator::position
1 parent 67cfbf3 commit f57a710

File tree

2 files changed

+29
-7
lines changed

2 files changed

+29
-7
lines changed

src/SUMMARY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
- [As output parameters](fn/closures/output_parameters.md)
7070
- [Examples in `std`](fn/closures/closure_examples.md)
7171
- [Iterator::any](fn/closures/closure_examples/iter_any.md)
72-
- [Iterator::find](fn/closures/closure_examples/iter_find.md)
72+
- [Searching through iterators](fn/closures/closure_examples/iter_find.md)
7373
- [Higher Order Functions](fn/hof.md)
7474
- [Diverging functions](fn/diverging.md)
7575

src/fn/closures/closure_examples/iter_find.md

+28-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Iterator::find
1+
# Searching through iterators
22

3-
`Iterator::find` is a function which when passed an iterator, will return
4-
the first element which satisfies the predicate as an `Option`. Its
5-
signature:
3+
`Iterator::find` is a function which iterates over an iterator and searches for the
4+
first value which satisfies some condition. If none of the values satisfy the
5+
condition, it returns `None`. Its signature:
66

77
```rust,ignore
88
pub trait Iterator {
@@ -29,9 +29,11 @@ fn main() {
2929
// `into_iter()` for vecs yields `i32`.
3030
let mut into_iter = vec2.into_iter();
3131
32-
// A reference to what is yielded is `&&i32`. Destructure to `i32`.
32+
// `iter()` for vecs yields `&i32`, and we want to reference one of its
33+
// items, so we have to destructure `&&i32` to `i32`
3334
println!("Find 2 in vec1: {:?}", iter .find(|&&x| x == 2));
34-
// A reference to what is yielded is `&i32`. Destructure to `i32`.
35+
// `into_iter()` for vecs yields `i32`, and we want to reference one of
36+
// its items, so we have to destructure `&i32` to `i32`
3537
println!("Find 2 in vec2: {:?}", into_iter.find(| &x| x == 2));
3638
3739
let array1 = [1, 2, 3];
@@ -44,8 +46,28 @@ fn main() {
4446
}
4547
```
4648

49+
`Iterator::find` gives you a reference to the item. But if you want the _index_ of the
50+
item, use `Iterator::position`.
51+
52+
```rust,editable
53+
fn main() {
54+
let vec = vec![1, 9, 3, 3, 13, 2];
55+
56+
let index_of_first_even_number = vec.iter().position(|x| x % 2 == 0);
57+
assert_eq!(index_of_first_even_number, Some(5));
58+
59+
60+
let index_of_first_negative_number = vec.iter().position(|x| x < &0);
61+
assert_eq!(index_of_first_negative_number, None);
62+
}
63+
```
64+
4765
### See also:
4866

4967
[`std::iter::Iterator::find`][find]
68+
[`std::iter::Iterator::position`][position]
5069

5170
[find]: https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.find
71+
[find_map]: https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.find_map
72+
[position]: https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.position
73+
[rposition]: https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.rposition

0 commit comments

Comments
 (0)