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
//! This create providers an implementation of `PushBackIterator` which is a
//! wrapper around an iterator which allows for items to be pushed back onto
//! the iterator to be consumed on subsequent call to `next()`.
//!
//! ```
//! use pushback_iter::PushBackIterator;
//!
//! let items = vec![1, 2, 3];
//! let mut iter = PushBackIterator::from(items.into_iter());
//!
//! let item = iter.next().unwrap();
//! assert_eq!(item, 1);
//!
//! iter.push_back(item);
//! assert_eq!(iter.next(), Some(1));
//!
//! iter.push_back(6);
//! iter.push_back(5);
//! assert_eq!(iter.next(), Some(5));
//! assert_eq!(iter.next(), Some(6));
//! assert_eq!(iter.next(), Some(2));
//! ```

#![deny(
    missing_docs,
    missing_debug_implementations,
    unreachable_pub,
    broken_intra_doc_links
)]
#![warn(rust_2018_idioms)]

use std::collections::VecDeque;

/// An iterator with a `push_back(item)` method that allows
/// items to be pushed back onto the iterator.
///
/// [`Iterator`]: trait.Iterator.html
#[derive(Debug, Clone)]
pub struct PushBackIterator<I: Iterator> {
    buffer: VecDeque<I::Item>,
    inner: I,
}

impl<I: Iterator> PushBackIterator<I> {
    /// Push back an item to the beginning of the iterator.
    ///
    /// Items pushed back onto the iterator are returned from [`next`] in a
    /// last-in-first out basis.
    pub fn push_back(&mut self, item: I::Item) {
        self.buffer.push_back(item)
    }

    /// 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.
    #[inline]
    pub fn peek(&mut self) -> Option<&I::Item> {
        self.peek_nth(0)
    }

    /// Returns a reference to the nth(n) value without advancing the iterator.
    ///
    /// Like [`nth`], if there is a value, it is wrapped in a `Some(T)`.
    /// But if the iteration is over, `None` is returned.
    pub fn peek_nth(&mut self, n: usize) -> Option<&I::Item> {
        if n >= self.buffer.len() {
            for _ in 0..=(n - self.buffer.len()) {
                self.buffer.push_front(self.inner.next()?);
            }
        }
        Some(&self.buffer[self.buffer.len() - n - 1])
    }

    /// Reserves capacity for at least `additional` more elements in the push back buffer
    ///
    /// # Panics
    ///
    /// Panics if the new capacity overflows `usize`.
    ///
    pub fn reserve(&mut self, additional: usize) {
        self.buffer.reserve(additional)
    }

    /// Shrinks the capacity of the buffer as much as possible.
    ///
    pub fn shrink_to_fit(&mut self) {
        self.buffer.shrink_to_fit()
    }
}

impl<I: Iterator> From<I> for PushBackIterator<I> {
    fn from(inner: I) -> Self {
        PushBackIterator {
            buffer: VecDeque::new(),
            inner,
        }
    }
}

impl<I: Iterator> Iterator for PushBackIterator<I> {
    type Item = I::Item;

    fn next(&mut self) -> Option<Self::Item> {
        self.buffer.pop_back().or_else(|| self.inner.next())
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        let (lower, upper) = self.inner.size_hint();
        (
            lower + self.buffer.len(),
            upper.map(|upper| upper + self.buffer.len()),
        )
    }

    fn count(self) -> usize
    where
        Self: Sized,
    {
        self.buffer.len() + self.inner.count()
    }

    fn last(self) -> Option<Self::Item>
    where
        Self: Sized,
    {
        self.inner.last()
    }

    fn nth(&mut self, n: usize) -> Option<Self::Item> {
        if n < self.buffer.len() {
            self.buffer.truncate(self.buffer.len() - n);
            self.buffer.pop_back()
        } else {
            let n = n - self.buffer.len();
            self.buffer.clear();
            self.inner.nth(n)
        }
    }
}

impl<I: ExactSizeIterator> ExactSizeIterator for PushBackIterator<I> {
    fn len(&self) -> usize {
        self.buffer.len() + self.inner.len()
    }
}

impl<I: DoubleEndedIterator> DoubleEndedIterator for PushBackIterator<I> {
    fn next_back(&mut self) -> Option<Self::Item> {
        self.inner.next_back().or_else(|| self.buffer.pop_front())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn push_back() {
        let items = vec![0, 1, 2, 3];
        let mut iter = PushBackIterator::from(items.into_iter());
        assert_eq!(iter.next(), Some(0));
        assert_eq!(iter.next(), Some(1));
        iter.push_back(1);
        assert_eq!(iter.next(), Some(1));
        assert_eq!(iter.next(), Some(2));
        iter.push_back(2);
        iter.push_back(1);
        assert_eq!(iter.next(), Some(1));
        assert_eq!(iter.next(), Some(2));

        assert_eq!(iter.next(), Some(3));
        assert_eq!(iter.next(), None);

        iter.push_back(0);
        assert_eq!(iter.next(), Some(0));
        assert_eq!(iter.next(), None);
    }

    #[test]
    fn peek_nth() {
        let items = vec![0, 1, 2, 3, 4, 5];
        let mut iter = PushBackIterator::from(items.into_iter());
        assert_eq!(iter.peek_nth(2), Some(&2));
        assert_eq!(iter.peek_nth(2), Some(&2));
        assert_eq!(iter.next(), Some(0));
        assert_eq!(iter.peek_nth(2), Some(&3));
        iter.push_back(0);
        assert_eq!(iter.peek_nth(2), Some(&2));
        assert_eq!(iter.next(), Some(0));
        assert_eq!(iter.next(), Some(1));
        assert_eq!(iter.next(), Some(2));
        assert_eq!(iter.next(), Some(3));
    }
}