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 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
#![no_std]
#![deny(clippy::cargo_common_metadata)]
//! An iterator adapter to peek at future elements without advancing the cursor of the underlying
//! iterator.
//!
//! Check out [multipeek()] for more details.
//!
//! # Example
//!
//! ```rust
//! use multipeek::multipeek;
//!
//! let mut iter = multipeek([1, 2, 3, 4].into_iter());
//!
//! // Peek at the first element.
//! let first_peek = iter.peek().cloned();
//! assert_eq!(first_peek, Some(1));
//!
//! // Advance the iterator cursor to point at the first element.
//! let first = iter.next();
//! assert_eq!(first, first_peek);
//!
//! // Peek two steps ahead, at the third element.
//! let third_peek = iter.peek_nth(1).cloned();
//! assert_eq!(third_peek, Some(3));
//!
//! // Advance the iterator cursor twice.
//! // The iterator cursor will now point to the third element.
//! iter.next();
//! let third = iter.next();
//! assert_eq!(third_peek, third);
//!
//! // Peeking beyond the end of the iterator returns `None`.
//! let ambitious_peek = iter.peek_nth(5);
//! assert!(ambitious_peek.is_none());
//! ```
//!
//! # `no_std`
//!
//! `multipeek` can be used in `no_std` environments. It requires an allocator.
//!
//! # Alternatives and previous art
//!
//! Rust's standard library provides [`Peekable`](https://doc.rust-lang.org/stable/std/iter/struct.Peekable.html).
//! It lets you peek at the next element in an iterator, but there is no way to look further ahead.
//!
//! `itertools`'s provides [`MultiPeek`](https://docs.rs/itertools/latest/itertools/structs/struct.MultiPeek.html).
//! It lets you peek as far ahead as you want, but [`MultiPeek::peek`](https://docs.rs/itertools/latest/itertools/structs/struct.MultiPeek.html#method.peek)
//! is not idempotent: calling `peek` once returns the next element, calling `peek` again
//! returns the second-next element.
//!
//! `multipeek`, just like `itertools`, gives you the possibility to peek as far ahead as you want.
//! Our [`MultiPeek::peek`] implementation is idempotent: [`MultiPeek::peek`] always returns
//! the next element.
//! You can peek further ahead using [`MultiPeek::peek_nth`], you just need to specify how
//! many steps ahead you want to look at.
//!
//! Our [`MultiPeek`] implementation is directly inspired by `itertools`' implementation.
extern crate alloc;
extern crate core as std;
use alloc::collections::VecDeque;
use std::iter::{Fuse, FusedIterator};
/// A wrapper type around the underlying iterator.
///
/// See [MultiPeek::peek()] and [MultiPeek::peek_nth()] for more details.
#[derive(Clone, Debug)]
pub struct MultiPeek<I>
where
I: Iterator,
{
iter: Fuse<I>,
buf: VecDeque<I::Item>,
}
/// An iterator adapter to peek at future elements without advancing the cursor of the underlying
/// iterator.
///
/// See [MultiPeek::peek()] and [MultiPeek::peek_nth()] for more details.
///
/// # Example
///
/// ```rust
/// use multipeek::multipeek;
///
/// let mut iter = multipeek([1, 2, 3, 4].into_iter());
///
/// // Peek at the first element.
/// let first_peek = iter.peek().cloned();
/// assert_eq!(first_peek, Some(1));
///
/// // Advance the iterator cursor to point at the first element.
/// let first = iter.next();
/// assert_eq!(first, first_peek);
///
/// // Peek two steps ahead, at the third element.
/// let third_peek = iter.peek_nth(1).cloned();
/// assert_eq!(third_peek, Some(3));
///
/// // Advance the iterator cursor twice. The iterator cursor will now point to the third element.
/// iter.next();
/// let third = iter.next();
/// assert_eq!(third_peek, third);
///
/// // Peeking beyond the end of the iterator returns `None`.
/// let ambitious_peek = iter.peek_nth(5);
/// assert!(ambitious_peek.is_none());
/// ```
pub fn multipeek<I>(iterable: I) -> MultiPeek<I::IntoIter>
where
I: IntoIterator,
{
MultiPeek {
iter: iterable.into_iter().fuse(),
buf: VecDeque::new(),
}
}
impl<I: Iterator> MultiPeek<I> {
/// It returns the next element in the iterator without advancing the iterator cursor.
///
/// `.peek()` is idempotent: it always returns the next element, no matter how many times
/// it is called.
///
/// # Example: `peek` vs `next`
///
/// ```rust
/// use multipeek::IteratorExt as _;
///
/// let mut iter = [1, 2, 3, 4].into_iter().multipeek();
///
/// // Peek at the first element.
/// let first_peek = iter.peek().cloned();
/// assert_eq!(first_peek, Some(1));
///
/// // Advance the iterator cursor to point at the first element.
/// let first = iter.next();
/// assert_eq!(first, first_peek);
///
/// // Peek now returns the second element.
/// let second_peek = iter.peek().cloned();
/// assert_eq!(second_peek, Some(2));
/// ```
///
/// # Example: `peek` is idempotent
///
/// ```rust
/// use multipeek::IteratorExt as _;
///
/// let mut iter = [1, 2, 3, 4].into_iter().multipeek();
///
/// // Peek at the first element, multiple times.
/// let first_peek = iter.peek().cloned();
/// let second_peek = iter.peek().cloned();
/// assert_eq!(first_peek, Some(1));
/// assert_eq!(first_peek, second_peek);
/// ```
///
/// # Implementation notes
///
/// `peek`, underneath, calls `next` on the wrapped iterator.
/// The returned element is stored in a buffer. When the user code calls `next`, [`MultiPeek`]
/// returns the stored element from the buffer instead of calling `next` on the underlying
/// iterator again.
pub fn peek(&mut self) -> Option<&I::Item> {
self.peek_nth(0)
}
/// It returns the n-th future element in the iterator without advancing the iterator cursor.
///
/// E.g. `peek_nth(0)` returns the next element, just like [`MultiPeek::peek()`].
/// E.g. `peek_nth(1)` returns the second-next element, the same element that would be returned
/// by calling `.next` twice.
///
/// `peek_nth()` is idempotent: it always returns the n-th future element, no matter how many
/// times it is called (assuming the iterator hasn't advanced).
///
/// # Example: `peek_nth` vs `next`
///
/// ```rust
/// use multipeek::IteratorExt as _;
///
/// let mut iter = [1, 2, 3, 4].into_iter().multipeek();
///
/// // Peek at the second element.
/// let peek = iter.peek_nth(1).cloned();
/// assert_eq!(peek, Some(2));
///
/// // Advance the iterator cursor twice to point at the second element.
/// iter.next();
/// let third = iter.next();
/// assert_eq!(third, peek);
/// ```
///
/// # Example: `peek_nth` is idempotent
///
/// ```rust
/// use multipeek::IteratorExt as _;
///
/// let mut iter = [1, 2, 3, 4].into_iter().multipeek();
///
/// // Peek at the first element, multiple times.
/// let first_peek = iter.peek_nth(3).cloned();
/// let second_peek = iter.peek_nth(3).cloned();
/// assert_eq!(first_peek, Some(4));
/// assert_eq!(first_peek, second_peek);
/// ```
///
/// # Example: `peek_nth` vs `peek`
///
/// ```rust
/// use multipeek::IteratorExt as _;
///
/// let mut iter = [1, 2, 3, 4].into_iter().multipeek();
///
/// // Peek at the next element, using both peek and peek_nth.
/// let first_peek = iter.peek_nth(0).cloned();
/// let second_peek = iter.peek().cloned();
/// assert_eq!(first_peek, Some(1));
/// assert_eq!(first_peek, second_peek);
/// ```
/// # Implementation notes
///
/// ## Performance
///
/// `peek_nth`, underneath, calls `next` on the wrapped iterator `n+1` times.
/// The returned elements are stored in a buffer. When the user code calls `next`, [`MultiPeek`]
/// returns elements from the buffer until it's empty instead of calling `next` on the
/// underlying iterator again.
///
/// This buffering can lead to significant memory usage if `peek_nth` is invoked with
/// a large `n` value.
///
/// ## API design
///
/// What should `peek_nth(1)` return? The next element? The second next?
/// We chose to be consistent with the APIs provided by Rust's standard library.
/// [`Iterator::nth`](https://doc.rust-lang.org/stable/std/iter/trait.Iterator.html#method.nth)
/// uses 0-based indexing - i.e. `.nth(0)` is equivalent to `.next()`. We follow the same
/// indexing strategy.
pub fn peek_nth(&mut self, n: usize) -> Option<&I::Item> {
while n >= self.buf.len() {
let item = self.iter.next()?;
self.buf.push_back(item);
}
Some(&self.buf[n])
}
}
impl<I> Iterator for MultiPeek<I>
where
I: Iterator,
{
type Item = I::Item;
fn next(&mut self) -> Option<Self::Item> {
self.buf.pop_front().or_else(|| self.iter.next())
}
fn size_hint(&self) -> (usize, Option<usize>) {
let (mut low, mut high) = self.iter.size_hint();
low = low.saturating_add(self.buf.len());
high = high.and_then(|elt| elt.checked_add(self.buf.len()));
(low, high)
}
}
/// An extension trait to add a `multipeek` method to all the types that implement the
/// `Iterator` trait.
///
/// ```rust
/// // You can get an instance of `MultiPeek` by using `multipeek`
/// use multipeek::multipeek;
/// let mut iter = multipeek([1, 2, 3, 4].into_iter());
///
/// // By importing `IteratorExt` you can instead use `multipeek` as a method
/// // on the iterable. If you like method chaining, this is for you!
/// use multipeek::IteratorExt as _;
///
/// let mut iter = [1, 2, 3, 4].into_iter().multipeek();
///
/// ```
pub trait IteratorExt: Iterator {
fn multipeek(self) -> MultiPeek<Self>
where
Self: Sized,
{
multipeek(self)
}
}
impl<T> IteratorExt for T where T: Iterator {}
// Same size
impl<I> ExactSizeIterator for MultiPeek<I> where I: ExactSizeIterator {}
// The underlying iterator we are wrapping in [`MultiPeek`] is fused in [`multipeek`].
impl<I> FusedIterator for MultiPeek<I> where I: Iterator {}