Import 'peeking_take_while' package vesion 0.1.2 am: 481287ddbc am: 126426f206

Change-Id: I60a10bac827e783ff594b13bfadd7a16b36da9e8

12 files changed, 465 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..4308d82
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+target/
+**/*.rs.bk
+Cargo.lock
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..76aa37f
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,18 @@
+sudo: false
+language: rust
+
+rust:
+  - stable
+  - beta
+  - nightly
+
+cache: cargo
+
+env:
+  matrix:
+    - PROFILE=""
+    - PROFILE="--release"
+
+script:
+  - cargo build $PROFILE --verbose
+  - cargo test $PROFILE --verbose
diff --git a/Android.bp b/Android.bp
new file mode 100644
index 0000000..1fd0cf4
--- /dev/null
+++ b/Android.bp
@@ -0,0 +1,8 @@
+// This file is generated by cargo2android.py.
+
+rust_library_host_rlib {
+    name: "libpeeking_take_while",
+    crate_name: "peeking_take_while",
+    srcs: ["src/lib.rs"],
+    edition: "2015",
+}
diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644
index 0000000..40aeef2
--- /dev/null
+++ b/Cargo.toml
@@ -0,0 +1,14 @@
+[package]
+authors = ["Nick Fitzgerald <fitzgen@gmail.com>"]
+description = "Like `Iterator::take_while`, but calls the predicate on a peeked value. This allows you to use `Iterator::by_ref` and `Iterator::take_while` together, and still get the first value for which the `take_while` predicate returned false after dropping the `by_ref`."
+categories = ["rust-patterns"]
+keywords = ["iterator", "take_while", "peek", "by_ref"]
+license = "Apache-2.0/MIT"
+name = "peeking_take_while"
+readme = "./README.md"
+repository = "https://github.com/fitzgen/peeking_take_while"
+version = "0.1.2"
+
+[badges]
+[badges.travis-ci]
+repository = "fitzgen/peeking_take_while"
diff --git a/LICENSE b/LICENSE
new file mode 120000
index 0000000..6b579aa
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1 @@
+LICENSE-APACHE
\ No newline at end of file
diff --git a/LICENSE-APACHE b/LICENSE-APACHE
new file mode 100644
index 0000000..16fe87b
--- /dev/null
+++ b/LICENSE-APACHE
@@ -0,0 +1,201 @@
+                              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
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/LICENSE-MIT b/LICENSE-MIT
new file mode 100644
index 0000000..e69282e
--- /dev/null
+++ b/LICENSE-MIT
@@ -0,0 +1,25 @@
+Copyright (c) 2015 The Rust Project Developers
+
+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.
diff --git a/METADATA b/METADATA
new file mode 100644
index 0000000..85c6822
--- /dev/null
+++ b/METADATA
@@ -0,0 +1,19 @@
+name: "peeking_take_while"
+description: "Provides the peeking_take_while iterator adaptor method."
+third_party {
+  url {
+    type: HOMEPAGE
+    value: "https://crates.io/crates/peeking_take_while"
+  }
+  url {
+    type: GIT
+    value: "https://github.com/fitzgen/peeking_take_while"
+  }
+  version: "0.1.2"
+  license_type: NOTICE
+  last_upgrade_date {
+    year: 2020
+    month: 3
+    day: 31
+  }
+}
diff --git a/MODULE_LICENSE_APACHE2 b/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/MODULE_LICENSE_APACHE2
diff --git a/OWNERS b/OWNERS
new file mode 100644
index 0000000..46fc303
--- /dev/null
+++ b/OWNERS
@@ -0,0 +1 @@
+include platform/prebuilts/rust:/OWNERS
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c7486b7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+# `peeking_take_while`
+
+[![Build Status](https://travis-ci.org/fitzgen/peeking_take_while.png?branch=master)](https://travis-ci.org/fitzgen/peeking_take_while)
+
+Provides the `peeking_take_while` iterator adaptor method.
+
+The `peeking_take_while` method is very similar to `take_while`, but behaves
+differently when used with a borrowed iterator (perhaps returned by
+`Iterator::by_ref`).
+
+`peeking_take_while` peeks at the next item in the iterator and runs the
+predicate on that peeked item. This avoids consuming the first item yielded by
+the underlying iterator for which the predicate returns `false`. On the other
+hand, `take_while` will consume that first item for which the predicate returns
+`false`, and it will be lost.
+
+```rust
+extern crate peeking_take_while;
+
+// Bring the `peeking_take_while` method for peekable iterators into
+// scope.
+use peeking_take_while::PeekableExt;
+
+// Let's say we have two collections we want to iterate through: `xs` and
+// `ys`. We want to perform one operation on all the leading contiguous
+// elements that match some predicate, and a different thing with the rest of
+// the elements. With the `xs`, we will use the normal `take_while`. With the
+// `ys`, we will use `peeking_take_while`.
+
+let xs: Vec<u8> = (0..100).collect();
+let ys = xs.clone();
+
+let mut iter_xs = xs.into_iter();
+let mut iter_ys = ys.into_iter().peekable();
+
+{
+    // Let's do one thing with all the items that are less than 10.
+
+    let xs_less_than_ten = iter_xs.by_ref().take_while(|x| *x < 10);
+    for x in xs_less_than_ten {
+        do_things_with(x);
+    }
+
+    let ys_less_than_ten = iter_ys.by_ref().peeking_take_while(|y| *y < 10);
+    for y in ys_less_than_ten {
+        do_things_with(y);
+    }
+}
+
+// And now we will do some other thing with the items that are greater than
+// or equal to 10.
+
+// ...except, when using plain old `take_while` we lost 10!
+assert_eq!(iter_xs.next(), Some(11));
+
+// However, when using `peeking_take_while` we did not! Great!
+assert_eq!(iter_ys.next(), Some(10));
+```
diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..67f36d8
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,117 @@
+//! # `peeking_take_while`
+//!
+//! Provides the `peeking_take_while` iterator adaptor method.
+//!
+//! The `peeking_take_while` method is very similar to `take_while`, but behaves
+//! differently when used with a borrowed iterator (perhaps returned by
+//! `Iterator::by_ref`).
+//!
+//! `peeking_take_while` peeks at the next item in the iterator and runs the
+//! predicate on that peeked item. This avoids consuming the first item yielded
+//! by the underlying iterator for which the predicate returns `false`. On the
+//! other hand, `take_while` will consume that first item for which the
+//! predicate returns `false`, and it will be lost.
+//!
+//! ```
+//! extern crate peeking_take_while;
+//!
+//! // Bring the `peeking_take_while` method for peekable iterators into
+//! // scope.
+//! use peeking_take_while::PeekableExt;
+//!
+//! # fn main() {
+//! // Let's say we have two collections we want to iterate through: `xs` and
+//! // `ys`. We want to perform one operation on all the leading contiguous
+//! // elements that match some predicate, and a different thing with the rest of
+//! // the elements. With the `xs`, we will use the normal `take_while`. With the
+//! // `ys`, we will use `peeking_take_while`.
+//!
+//! let xs: Vec<u8> = (0..100).collect();
+//! let ys = xs.clone();
+//!
+//! let mut iter_xs = xs.into_iter();
+//! let mut iter_ys = ys.into_iter().peekable();
+//!
+//! {
+//!     // Let's do one thing with all the items that are less than 10.
+//! #   fn do_things_with<T>(_: T) {}
+//!
+//!     let xs_less_than_ten = iter_xs.by_ref().take_while(|x| *x < 10);
+//!     for x in xs_less_than_ten {
+//!         do_things_with(x);
+//!     }
+//!
+//!     let ys_less_than_ten = iter_ys.by_ref().peeking_take_while(|y| *y < 10);
+//!     for y in ys_less_than_ten {
+//!         do_things_with(y);
+//!     }
+//! }
+//!
+//! // And now we will do some other thing with the items that are greater than
+//! // or equal to 10.
+//!
+//! // ...except, when using plain old `take_while` we lost 10!
+//! assert_eq!(iter_xs.next(), Some(11));
+//!
+//! // However, when using `peeking_take_while` we did not! Great!
+//! assert_eq!(iter_ys.next(), Some(10));
+//! # }
+//! ```
+
+use std::iter::Peekable;
+
+/// The iterator returned by `peeking_take_while`.
+///
+/// See the [module documentation](./index.html) for details.
+pub struct PeekingTakeWhile<'a, I, P>
+    where I: 'a + Iterator
+{
+    iter: &'a mut Peekable<I>,
+    predicate: P,
+}
+
+impl<'a, I, P> Iterator for PeekingTakeWhile<'a, I, P>
+    where I: Iterator,
+          I::Item: ::std::fmt::Debug,
+          P: FnMut(&<I as Iterator>::Item) -> bool
+{
+    type Item = <I as Iterator>::Item;
+
+    fn next(&mut self) -> Option<Self::Item> {
+        let predicate = &mut self.predicate;
+        if self.iter.peek().map_or(false, |x| !(predicate)(x)) {
+            None
+        } else {
+            self.iter.next()
+        }
+    }
+}
+
+/// The `Iterator` extension trait that provides the `peeking_take_while`
+/// method.
+///
+/// See the [module documentation](./index.html) for details.
+pub trait PeekableExt<'a, I>: Iterator
+    where I: 'a + Iterator
+{
+    /// The `Iterator` extension trait that provides the `peeking_take_while`
+    /// method.
+    ///
+    /// See the [module documentation](./index.html) for details.
+    fn peeking_take_while<P>(&'a mut self, predicate: P) -> PeekingTakeWhile<'a, I, P>
+        where Self: Sized,
+              P: FnMut(&<Self as Iterator>::Item) -> bool;
+}
+
+impl<'a, I> PeekableExt<'a, I> for Peekable<I>
+    where I: 'a + Iterator
+{
+    fn peeking_take_while<P>(&'a mut self, predicate: P) -> PeekingTakeWhile<I, P>
+        where P: FnMut(&<Self as Iterator>::Item) -> bool
+    {
+        PeekingTakeWhile {
+            iter: self,
+            predicate: predicate,
+        }
+    }
+}