itermore 0.8.0

🤸‍♀️ More iterator adaptors
Documentation 
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212

//! 🤸‍♀️ More iterator adaptors.
//!
//! This crate provides some useful iterator adaptors and functions. Unlike
//! [`itertools`](https://docs.rs/itertools) this crate provides a separate
//! extension trait for each adaptor. Additionally, each type of adaptor is
//! feature flagged so you only have to compile the features you need.
//!
//! # Getting started
//!
//! Add the crate to Cargo manifest.
//! ```sh
//! cargo add itermore --features full
//! ```
//!
//! And bring the extension traits into scope.
//!
//! ```
//! use itermore::prelude::*;
//! ```
//!
//! Now you can use extension methods like [`array_windows`] on any iterator.
//! ```
//! # use itermore::prelude::*;
//! # let iter = [1, 2, 3, 4, 5].into_iter();
//! for [a, b, c] in iter.array_windows() {
//!     println!("{} {} {}", a, b, c)
//! }
//! // Outputs
//! //    1 2 3
//! //    2 3 4
//! //    3 4 5
//! ```
//!
//! It is recommended to only enable the features that you need. For example if
//! you only want the [`array_combinations`] adaptor you would add the following
//! to your Cargo manifest.
//! ```toml
//! [dependencies]
//! itermore = { version = "*", features = ["array_combinations"]}
//! ```
//!
//! # Provided functionality
//!
//! ## Methods
//!
//! - [`collect_array`]: Collects an iterator into an array.
//! - [`min_max`] and friends: Returns the minimum and maximum element of an
//!   iterator.
//! - [`next_chunk`]: Returns the next `N` elements of the iterator as an array.
//! - [`sorted`] and friends: Returns a new iterator with all elements sorted.
//!
//! [`collect_array`]: IterCollectArray::collect_array
//! [`min_max`]: IterMinMax::min_max
//! [`next_chunk`]: IterNextChunk::next_chunk
//! [`sorted`]: IterSorted::sorted
//!
//! ## Adaptors
//!
//! - [`array_chunks`] returns an iterator over `N` elements of the iterator at
//!   a time.
//! - [`array_windows`] returns an iterator over all contiguous windows of
//!   length `N`.
//! - [`array_combinations`] returns an iterator over `K` length combinations of
//!   all the elements in the underlying iterator.
//! - [`array_combinations_with_reps`] returns an iterator over `K` length
//!   combinations with repetitions/replacements of all the elements in the
//!   underlying iterator.
//! - [`cartesian_product`] returns an iterator over the cartesian product of
//!   the element sets of two iterators.
//! - [`circular_array_windows`] returns an iterator over all contiguous windows
//!   of length `N` that wraps around at the end.
//! - [`combinations`] returns an iterator over `k` length combinations of all
//!   the elements in the underlying iterator.
//! - [`combinations_with_reps`] returns an iterator over `k` length
//!   combinations with repetitions/replacements of all the elements in the
//!   underlying iterator.
//!
//! [`array_chunks`]: IterArrayChunks::array_chunks
//! [`array_combinations`]: IterArrayCombinations::array_combinations
//! [`array_combinations_with_reps`]: IterArrayCombinationsWithReps::array_combinations_with_reps
//! [`array_windows`]: IterArrayWindows::array_windows
//! [`cartesian_product`]: IterCartesianProduct::cartesian_product
//! [`circular_array_windows`]: IterCircularArrayWindows::circular_array_windows
//! [`combinations`]: IterCombinations::combinations
//! [`combinations_with_reps`]: IterCombinationsWithReps::combinations_with_reps

#![warn(unsafe_op_in_unsafe_fn)]
#![cfg_attr(not(feature = "alloc"), no_std)]
#![cfg_attr(docsrs, feature(doc_cfg))]

#[cfg(feature = "alloc")]
extern crate alloc;

mod adaptors;
#[cfg(feature = "cartesian_product")]
mod flatten_tuple;
mod xtraits;

// For macros
#[doc(hidden)]
#[cfg(feature = "cartesian_product")]
pub use crate::flatten_tuple::flatten_tuple;
#[doc(hidden)]
pub use core;

#[cfg(feature = "array_chunks")]
#[cfg_attr(docsrs, doc(cfg(feature = "array_chunks")))]
pub use crate::adaptors::array_chunks::{ArrayChunks, IterArrayChunks};

#[cfg(feature = "array_combinations")]
#[cfg_attr(docsrs, doc(cfg(feature = "array_combinations")))]
pub use crate::adaptors::array_combinations::{ArrayCombinations, IterArrayCombinations};

#[cfg(feature = "array_combinations_with_reps")]
#[cfg_attr(docsrs, doc(cfg(feature = "array_combinations_with_reps")))]
pub use crate::adaptors::array_combinations_with_reps::{
    ArrayCombinationsWithReps, IterArrayCombinationsWithReps,
};

#[cfg(feature = "array_windows")]
#[cfg_attr(docsrs, doc(cfg(feature = "array_windows")))]
pub use crate::adaptors::array_windows::{ArrayWindows, IterArrayWindows};

#[cfg(feature = "cartesian_product")]
#[cfg_attr(docsrs, doc(cfg(feature = "cartesian_product")))]
pub use crate::adaptors::cartesian_product::{CartesianProduct, IterCartesianProduct};

#[cfg(feature = "circular_array_windows")]
#[cfg_attr(docsrs, doc(cfg(feature = "circular_array_windows")))]
pub use crate::adaptors::circular_array_windows::{CircularArrayWindows, IterCircularArrayWindows};

#[cfg(feature = "collect_array")]
#[cfg_attr(docsrs, doc(cfg(feature = "collect_array")))]
pub use crate::xtraits::collect_array::IterCollectArray;

#[cfg(feature = "combinations")]
#[cfg_attr(docsrs, doc(cfg(feature = "combinations")))]
pub use crate::adaptors::combinations::{Combinations, IterCombinations};

#[cfg(feature = "combinations_with_reps")]
#[cfg_attr(docsrs, doc(cfg(feature = "combinations_with_reps")))]
pub use crate::adaptors::combinations_with_reps::{CombinationsWithReps, IterCombinationsWithReps};

#[cfg(feature = "min_max")]
#[cfg_attr(docsrs, doc(cfg(feature = "min_max")))]
pub use crate::xtraits::min_max::IterMinMax;

#[cfg(feature = "next_chunk")]
#[cfg_attr(docsrs, doc(cfg(feature = "next_chunk")))]
pub use crate::xtraits::next_chunk::IterNextChunk;

#[cfg(feature = "sorted")]
#[cfg_attr(docsrs, doc(cfg(feature = "sorted")))]
pub use crate::xtraits::sorted::IterSorted;

/// Re-exports all iterator extension traits.
///
/// The intention is that this module is used as a `*` import.
/// ```
/// use itermore::prelude::*;
/// ```
/// If you want to refer to a trait directly rather import it from the crate
/// root.
pub mod prelude {
    #[cfg(feature = "array_chunks")]
    #[cfg_attr(docsrs, doc(cfg(feature = "array_chunks")))]
    pub use super::IterArrayChunks;

    #[cfg(feature = "array_combinations")]
    #[cfg_attr(docsrs, doc(cfg(feature = "array_combinations")))]
    pub use super::IterArrayCombinations;

    #[cfg(feature = "array_combinations_with_reps")]
    #[cfg_attr(docsrs, doc(cfg(feature = "array_combinations_with_reps")))]
    pub use super::IterArrayCombinationsWithReps;

    #[cfg(feature = "array_windows")]
    #[cfg_attr(docsrs, doc(cfg(feature = "array_windows")))]
    pub use super::IterArrayWindows;

    #[cfg(feature = "cartesian_product")]
    #[cfg_attr(docsrs, doc(cfg(feature = "cartesian_product")))]
    pub use super::IterCartesianProduct;

    #[cfg(feature = "circular_array_windows")]
    #[cfg_attr(docsrs, doc(cfg(feature = "circular_array_windows")))]
    pub use super::IterCircularArrayWindows;

    #[cfg(feature = "collect_array")]
    #[cfg_attr(docsrs, doc(cfg(feature = "collect_array")))]
    pub use super::IterCollectArray;

    #[cfg(feature = "combinations")]
    #[cfg_attr(docsrs, doc(cfg(feature = "combinations")))]
    pub use super::IterCombinations;

    #[cfg(feature = "combinations_with_reps")]
    #[cfg_attr(docsrs, doc(cfg(feature = "combinations_with_reps")))]
    pub use super::IterCombinationsWithReps;

    #[cfg(feature = "min_max")]
    #[cfg_attr(docsrs, doc(cfg(feature = "min_max")))]
    pub use super::IterMinMax;

    #[cfg(feature = "next_chunk")]
    #[cfg_attr(docsrs, doc(cfg(feature = "next_chunk")))]
    pub use super::IterNextChunk;

    #[cfg(feature = "sorted")]
    #[cfg_attr(docsrs, doc(cfg(feature = "sorted")))]
    pub use super::IterSorted;
}