1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
//! [![github]](https://github.com/dtolnay/reduce) [![crates-io]](https://crates.io/crates/reduce) [![docs-rs]](https://docs.rs/reduce)
//!
//! [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github
//! [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust
//! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs
//!
//! <br>
//!
//! This crate gives Iterators a `reduce` function that is similar to
//! [`fold`](https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.fold)
//! but without an initial value. The function returns `None` if
//! the iterator is empty and `Some(value)` otherwise. This matches the distinction
//! between
//! [`reduce`](https://www.scala-lang.org/api/current/scala/collection/Iterator.html#reduce[A1%3E:A](op:(A1,A1)=%3EA1):A1)
//! and
//! [`fold`](https://www.scala-lang.org/api/current/scala/collection/Iterator.html#fold[A1%3E:A](z:A1)(op:(A1,A1)=%3EA1):A1)
//! in Scala.
//!
//! # Examples
//!
//! ```rust
//! use reduce::Reduce;
//!
//! fn main() {
//! // Reduce a non-empty iterator into Some(value)
//! let v = vec![1usize, 2, 3, 4, 5];
//! let sum = v.into_iter().reduce(|a, b| a + b);
//! assert_eq!(Some(15), sum);
//!
//! // Reduce an empty iterator into None
//! let v = Vec::<usize>::new();
//! let sum = v.into_iter().reduce(|a, b| a + b);
//! assert_eq!(None, sum);
//! }
//! ```