diff options
author | David LeGare <legare@google.com> | 2022-03-04 02:16:57 +0000 |
---|---|---|
committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | 2022-03-04 02:16:57 +0000 |
commit | 3e702301659e7c42649e5c896a1bd9397e0e9b10 (patch) | |
tree | 0ca62eb5d0beeab0cb7ee3c0db8111e81788c2cd /README.md | |
parent | 6d53fd1c74bf26ad082e430482e1328d63b831ad (diff) | |
parent | 0b915f7185875ec5439b7b4fc0d640dff833a608 (diff) | |
download | itertools-3e702301659e7c42649e5c896a1bd9397e0e9b10.tar.gz |
Update itertools to 0.10.3 am: b72e905c59 am: 49f788bc75 am: 0b915f7185
Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/itertools/+/2005035
Change-Id: I668cbaecaf3103c0a394c5576e44163210def870
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4cc3f8f --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# Itertools + +Extra iterator adaptors, functions and macros. + +Please read the [API documentation here](https://docs.rs/itertools/). + +[![build_status](https://github.com/rust-itertools/itertools/actions/workflows/ci.yml/badge.svg)](https://github.com/rust-itertools/itertools/actions) +[![crates.io](https://img.shields.io/crates/v/itertools.svg)](https://crates.io/crates/itertools) + +How to use with Cargo: + +```toml +[dependencies] +itertools = "0.10.2" +``` + +How to use in your crate: + +```rust +use itertools::Itertools; +``` + +## How to contribute + +- Fix a bug or implement a new thing +- Include tests for your new feature, preferably a QuickCheck test +- Make a Pull Request + +For new features, please first consider filing a PR to [rust-lang/rust](https://github.com/rust-lang/rust), +adding your new feature to the `Iterator` trait of the standard library, if you believe it is reasonable. +If it isn't accepted there, proposing it for inclusion in ``itertools`` is a good idea. +The reason for doing is this is so that we avoid future breakage as with ``.flatten()``. +However, if your feature involves heap allocation, such as storing elements in a ``Vec<T>``, +then it can't be accepted into ``libcore``, and you should propose it for ``itertools`` directly instead. + +## License + +Dual-licensed to be compatible with the Rust project. + +Licensed under the Apache License, Version 2.0 +https://www.apache.org/licenses/LICENSE-2.0 or the MIT license +https://opensource.org/licenses/MIT, at your +option. This file may not be copied, modified, or distributed +except according to those terms. |