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
//! `prev-iter` contains an iterator which allows you to view the previous element. use std::iter::Peekable; use std::iter::Iterator; /// An iterator with `prev()`, `prev_peek()`, and `peek()` functions that return the previous element, a /// reference to the previous element, or a reference to the next element, respectively. /// /// This `struct` is created by passing an [`Iterator`] whose `Item` implements [`Clone`] to the /// [`new`] function. /// /// [`Iterator`]: https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html /// [`Clone`]: https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html /// [`new`]: struct.PrevPeekable.html#method.new pub struct PrevPeekable<I> where I: Iterator, <I as ::std::iter::Iterator>::Item: ::std::clone::Clone, { /// Iterator that `PrevPeekable` wraps iterator: Peekable<I>, /// The element before the one we just returned. Initially it's `None`. prev: Option<I::Item>, /// The current element we just returned. current: Option<I::Item>, /// Keeps track of whether the iterator has reached the end or not finished: bool, } impl<I> PrevPeekable<I> where I: Iterator, <I as ::std::iter::Iterator>::Item: ::std::clone::Clone, { /// Creates a new `PrevPeekable`. It takes an [`Iterator`] whose `Item` implements [`Clone`]. /// /// [`Iterator`]: https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html /// [`Clone`]: https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html /// /// # Examples /// /// Basic usage: /// /// ``` /// use prev_iter::PrevPeekable; /// /// let v = vec![1, 2, 3]; /// let mut iter = PrevPeekable::new(v.iter()); /// /// assert_eq!(Some(&1), iter.next()); /// assert_eq!(Some(&2), iter.next()); /// assert_eq!(Some(&1), iter.prev()); /// ``` pub fn new(iterator: I) -> Self { PrevPeekable { iterator: iterator.peekable(), prev: None, current: None, finished: false, } } /// Returns a reference to the `next()` value without advancing the iterator. /// /// Like [`next`], if there is a value, it is wrapped in a `Some(T)`. /// But if the iteration is over, `None` is returned. /// /// [`next`]: https://doc.rust-lang.org/nightly/core/iter/trait.Iterator.html#tymethod.next /// /// Because `peek()` returns a reference, and many iterators iterate over /// references, there can be a possibly confusing situation where the /// return value is a double reference. You can see this effect in the /// examples below. /// /// # Examples /// /// Basic usage: /// /// ``` /// let xs = [1, 2, 3]; /// /// let mut iter = xs.iter().peekable(); /// /// // peek() lets us see into the future /// assert_eq!(iter.peek(), Some(&&1)); /// assert_eq!(iter.next(), Some(&1)); /// /// assert_eq!(iter.next(), Some(&2)); /// /// // The iterator does not advance even if we `peek` multiple times /// assert_eq!(iter.peek(), Some(&&3)); /// assert_eq!(iter.peek(), Some(&&3)); /// /// assert_eq!(iter.next(), Some(&3)); /// /// // After the iterator is finished, so is `peek()` /// assert_eq!(iter.peek(), None); /// assert_eq!(iter.next(), None); /// ``` pub fn peek(&mut self) -> Option<&I::Item> { self.iterator.peek() } /// Returns the previous value in the iterator without moving the iterator backwards. /// When the end is reached, it will always return the last element. /// /// This function performs a `clone()` when returning the data. /// /// # Examples /// /// Basic usage: /// /// ``` /// use prev_iter::PrevPeekable; /// /// let v = vec![1, 2]; /// let mut it = PrevPeekable::new(v.iter()); /// /// // When the iterator is initialized there is not previous value /// assert_eq!(None, it.prev()); /// assert_eq!(Some(&1), it.next()); /// /// // There is no value before the first element /// assert_eq!(None, it.prev()); /// assert_eq!(Some(&2), it.next()); /// /// // Previous value before 2 is 1 /// assert_eq!(Some(&1), it.prev()); /// /// // The iterator doesn't have anymore values so the prev() will always /// // return the last element /// assert_eq!(None, it.next()); /// assert_eq!(Some(&2), it.prev()); /// ``` pub fn prev(&self) -> Option<I::Item> { self.prev.clone() } /// Returns a reference to the previous value in the iterator without moving the iterator /// backwards. When the end is reached, it will always return the last element. /// /// Because `prev_peek()` returns a reference, and many iterators iterate over /// references, there can be a possibly confusing situation where the /// return value is a double reference. You can see this effect in the /// examples below. /// /// # Examples /// /// Basic usage: /// /// ``` /// use prev_iter::PrevPeekable; /// /// let v = vec![1, 2]; /// let mut it = PrevPeekable::new(v.iter()); /// /// // Initially there is nothing to peek at /// assert_eq!(None, it.prev_peek()); /// assert_eq!(Some(&1), it.next()); /// /// // There is nothing before the first element /// assert_eq!(None, it.prev_peek()); /// assert_eq!(Some(&2), it.next()); /// /// // 1 comes before 2 /// assert_eq!(Some(&&1), it.prev_peek()); /// assert_eq!(None, it.next()); /// /// // 2 will always be returned as the last element /// assert_eq!(Some(&&2), it.prev_peek()); /// ``` pub fn prev_peek(&self) -> Option<&I::Item> { self.prev.as_ref() } } impl<I> Iterator for PrevPeekable<I> where I: Iterator, <I as ::std::iter::Iterator>::Item: ::std::clone::Clone, { type Item = I::Item; fn next(&mut self) -> Option<I::Item> { // If self.iterator.peek() is None, we've reached the end, and self.prev should // the second last element if let Some(_) = self.iterator.peek() { self.prev = std::mem::replace(&mut self.current, self.iterator.next()); return self.current.clone(); } else if !self.finished { self.prev = std::mem::replace(&mut self.current, self.iterator.next()); self.finished = true; } None } } #[cfg(test)] mod tests { use super::*; macro_rules! iter { ($v: expr) => {{ PrevPeekable::new($v.iter()) }}; } #[test] fn test_next() { let v = vec![1, 2, 3]; let mut iter = iter!(v); assert_eq!(Some(&1), iter.next()); assert_eq!(None, iter.prev); assert_eq!(Some(&2), iter.next()); assert_eq!(Some(&1), iter.prev); assert_eq!(Some(&3), iter.next()); assert_eq!(Some(&2), iter.prev); assert_eq!(None, iter.next()); assert_eq!(None, iter.next()); } #[test] fn test_peek() { let v = vec![1, 2]; let mut iter = iter!(v); assert_eq!(Some(&&1), iter.peek()); assert_eq!(Some(&1), iter.next()); assert_eq!(Some(&&2), iter.peek()); assert_eq!(Some(&2), iter.next()); assert_eq!(None, iter.next()); } #[test] fn test_prev() { let v = vec![1, 2]; let mut it = iter!(v); assert_eq!(None, it.prev()); assert_eq!(Some(&1), it.next()); assert_eq!(None, it.prev()); assert_eq!(Some(&2), it.next()); assert_eq!(Some(&1), it.prev()); assert_eq!(None, it.next()); assert_eq!(Some(&2), it.prev()); assert_eq!(None, it.next()); assert_eq!(Some(&2), it.prev()); } #[test] fn test_prev_peek() { let v = vec![1, 2]; let mut it = iter!(v); assert_eq!(None, it.prev_peek()); assert_eq!(Some(&1), it.next()); assert_eq!(None, it.prev_peek()); assert_eq!(Some(&2), it.next()); assert_eq!(Some(&&1), it.prev_peek()); assert_eq!(None, it.next()); assert_eq!(Some(&&2), it.prev_peek()); assert_eq!(None, it.next()); assert_eq!(Some(&&2), it.prev_peek()); } }