bump version number to 1.0.0

.github/workflows/rust.yml

@@ -0,0 +1,22 @@
+name: Rust
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build
+        run: cargo build --verbose
+      - name: Run tests
+        run: cargo test --verbose

Cargo.toml

@@ -1,9 +1,10 @@
 [package]
 name = "iter_accumulate"
-version = "0.1.0"
+version = "1.0.0"
 authors = ["Niklas Elsbrock <mail@nelsbrock.de>"]
 edition = "2021"
 description = "An iterator adaptor that accumulates the elements and yields the current accumulated value for each iteration"
 repository = "https://github.com/nelsbrock/iter_accumulate"
-license = "Apache-2.0"
+license = "MIT OR Apache-2.0"
 keywords = ["accumulate", "iterator", "fold"]
+categories = ["rust-patterns", "no-std"]

LICENSE-APACHE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Niklas Elsbrock
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,36 @@
+# iter_accumulate
+An iterator adaptor for Rust that accumulates the elements from the base iterator
+using the provided closure.
+
+## Example
+
+```rust
+use iter_accumulate::IterAccumulate;
+
+let input = [1, 2, 3, 4, 5];
+let mut iter = input.iter().accumulate(1, |acc, i| acc * i);
+
+assert_eq!(iter.next(), Some(1));
+assert_eq!(iter.next(), Some(2));
+assert_eq!(iter.next(), Some(6));
+assert_eq!(iter.next(), Some(24));
+assert_eq!(iter.next(), Some(120));
+assert_eq!(iter.next(), None);
+```
+
+## License
+
+Licensed under either of
+
+* Apache License, Version 2.0
+  ([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
+* MIT license
+  ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)
+
+at your option.
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.

src/lib.rs

@@ -1,12 +1,60 @@
 #![no_std]
 #![warn(missing_docs)]
 
-//! This crate provides the [`accumulate()`](IterAccumulate::accumulate) iterator adaptor.
+//! This crate provides [`accumulate()`], an iterator adaptor that accumulates the elements from the
+//! base iterator using the provided closure.
+//!
+//! [`accumulate()`] takes two arguments: an initial value, and a closure with two arguments:
+//! an 'accumulator', and an element.
+//!
+//! The initial value is the value the accumulator will have when the closure is first called.
+//! On each call to [`next()`], the closure is executed with the current accumulator and the element
+//! yielded by the upstream iterator. The return value of the closure is then set as the new value
+//! of the accumulator and returned to the caller.
+//!
+//! Since the accumulated value needs to be both stored as the accumulator *and* returned to the
+//! caller, the accumulator type must implement [`Clone`].
+//!
+//! The returned iterator is **not** fused and it is not specified what happens when the base
+//! iterator returns [`None`].
+//! If you want a fused iterator, use [`fuse()`].
+//!
+//! # Differences to [`fold()`]
+//!
+//! In principle, [`accumulate()`] is similar to [`fold()`]. However, instead of returning the final
+//! accumulated result, it returns an iterator that yields the current value of the accumulator for
+//! each iteration. In other words, the last element yielded by [`accumulate()`] is what would have
+//! been returned by [`fold()`] if it had been used instead.
+//!
+//! # Examples
+//!
+//! ```
+//! use iter_accumulate::IterAccumulate;
+//!
+//! let input = [1, 2, 3, 4, 5];
+//! let mut iter = input.iter().accumulate(1, |acc, i| acc * i);
+//!
+//! assert_eq!(iter.next(), Some(1));
+//! assert_eq!(iter.next(), Some(2));
+//! assert_eq!(iter.next(), Some(6));
+//! assert_eq!(iter.next(), Some(24));
+//! assert_eq!(iter.next(), Some(120));
+//! assert_eq!(iter.next(), None);
+//! ```
+//!
+//! [`accumulate()`]: IterAccumulate::accumulate
+//! [`fold()`]: Iterator::fold
+//! [`next()`]: Iterator::next
+//! [`fuse()`]: Iterator::fuse
+
+use core::fmt;
 
 /// An iterator adaptor that accumulates the elements from the base iterator using the provided
 /// closure.
 ///
-/// See [`IterAccumulate::accumulate()`] for more information.
+/// See the [crate-level documentation](crate) for more information.
+#[must_use = "iterator adaptors are lazy and do nothing unless consumed"]
+#[derive(Clone)]
 pub struct Accumulate<I, B, F> {
     iter: I,
     acc: B,
@@ -14,8 +62,21 @@ pub struct Accumulate<I, B, F> {
 }
 
 impl<I, B, F> Accumulate<I, B, F> {
-    fn new(iter: I, acc: B, f: F) -> Accumulate<I, B, F> {
+    fn new(iter: I, acc: B, f: F) -> Self {
-        Accumulate { iter, acc, f }
+        Self { iter, acc, f }
+    }
+}
+
+impl<I, B, F> fmt::Debug for Accumulate<I, B, F>
+where
+    I: fmt::Debug,
+    B: fmt::Debug,
+{
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        f.debug_struct("Accumulate")
+            .field("iter", &self.iter)
+            .field("acc", &self.acc)
+            .finish_non_exhaustive()
     }
 }
 
@@ -42,6 +103,11 @@ where
     fn size_hint(&self) -> (usize, Option<usize>) {
         self.iter.size_hint()
     }
+
+    #[inline]
+    fn count(self) -> usize {
+        self.iter.count()
+    }
 }
 
 /// An [`Iterator`] blanket implementation that provides the [`accumulate()`](Self::accumulate)
@@ -50,31 +116,7 @@ pub trait IterAccumulate: Iterator {
     /// Creates an iterator adaptor that accumulates the elements from the base iterator using the
     /// provided closure.
     ///
-    /// `accumulate()` is similar to [`fold()`], but instead of returning the final accumulated
+    /// See the [crate-level documentation](crate) for more information.
-    /// result, it returns an iterator that yields the current accumulated value for each iteration.
-    /// In other words, the last element yielded by `accumulate()` is what would have been returned
-    /// by [`fold()`] if it was used instead.
-    ///
-    /// The returned iterator is **not** fused and it is not specified what happens when the base
-    /// iterator returns [`None`].
-    /// If you want a fused iterator, use [`fuse()`].
-    ///
-    /// # Examples
-    ///
-    /// ```
-    /// use iter_accumulate::IterAccumulate;
-    ///
-    /// let input = [1, 2, 3, 4, 5];
-    /// let result = input
-    ///     .into_iter()
-    ///     .accumulate(1, |acc, i| acc * i)
-    ///     .collect::<Vec<_>>();
-    ///
-    /// assert_eq!(result, vec![1, 2, 6, 24, 120]);
-    /// ```
-    ///
-    /// [`fold()`]: Iterator::fold
-    /// [`fuse()`]: Iterator::fuse
     #[inline]
     fn accumulate<B, F>(self, init: B, f: F) -> Accumulate<Self, B, F>
     where