pub struct ShadowCountedIter<'a, I: Iterator, S = ()> { /* private fields */ }Expand description
An iterator that counts every iteration and optionally commits the count to a parent iterator. Can carry supplemental data of type S through the iteration process.
Note that the ShadowCountedIter implements methods on its own. These can only be accessed
while having the iterator itself available. Thus using a for loop is often not possible,
instead a while let Some(item) = iterator.next() {...} loop is required to iterate over
its elements.
Implementations§
Source§impl<'a, I: Iterator, S: Default> ShadowCountedIter<'a, I, S>
impl<'a, I: Iterator, S: Default> ShadowCountedIter<'a, I, S>
Source§impl<'a, I: Iterator, S> ShadowCountedIter<'a, I, S>
impl<'a, I: Iterator, S> ShadowCountedIter<'a, I, S>
Sourcepub fn new_with(iter: I, supplement: S) -> Self
pub fn new_with(iter: I, supplement: S) -> Self
Creates a new ShadowCountedIter from an iterator with specific supplemental data.
§Example
#[derive(Clone, Default)]
struct MyData { value: u32 }
impl Commit for MyData {
fn commit(&self, _from: Self) {}
}
let mut iter = vec![1, 2, 3].into_iter();
let mut iter = ShadowCountedIter::new_with(iter, MyData { value: 42 });
assert_eq!(iter.supplement().value, 42);
while let Some(_) = iter.next() {}
assert_eq!(iter.counter(), 3);Sourcepub fn supplement(&self) -> &S
pub fn supplement(&self) -> &S
Get a reference to the supplemental data.
§Example
#[derive(Clone, Default)]
struct MyData { value: u32 }
impl Commit for MyData {
fn commit(&self, _from: Self) {}
}
let mut iter = ShadowCountedIter::new_with(vec![1, 2].into_iter(), MyData { value: 42 });
assert_eq!(iter.supplement().value, 42);Sourcepub fn supplement_mut(&mut self) -> &mut S
pub fn supplement_mut(&mut self) -> &mut S
Get a mutable reference to the supplemental data.
§Example
#[derive(Clone, Default)]
struct MyData { value: u32 }
impl Commit for MyData {
fn commit(&self, _from: Self) {}
}
let mut iter = ShadowCountedIter::new_with(vec![1, 2].into_iter(), MyData { value: 42 });
iter.supplement_mut().value = 100;
assert_eq!(iter.supplement().value, 100);Source§impl<'a, I: Iterator, S: Clone> ShadowCountedIter<'a, I, S>
impl<'a, I: Iterator, S: Clone> ShadowCountedIter<'a, I, S>
Sourcepub fn new_nested<'b, T: Iterator>(
iter: I,
parent: &'a mut ShadowCountedIter<'b, T, S>,
) -> Self
pub fn new_nested<'b, T: Iterator>( iter: I, parent: &'a mut ShadowCountedIter<'b, T, S>, ) -> Self
Creates a new nested ShadowCountedIter with a reference to a parent iterator.
Nested iterators must be either committed to propagate their count to the parent.
The supplemental data is cloned from the parent.
§Arguments
parent- The parent iterator to commit the count to.
§Example
let mut parent_iter = vec![1, 2, 3].into_iter().shadow_counted();
parent_iter.next();
let mut nested_iter = vec![4,5].into_iter().nested_shadow_counted(&mut parent_iter);
assert_eq!(nested_iter.counter(), 1);
while let Some(_) = nested_iter.next() {}
assert_eq!(nested_iter.counter(), 3);
// destroy the nested iter while committing the count to the parent
nested_iter.commit();
while let Some(_) = parent_iter.next() {}
assert_eq!(parent_iter.counter(), 5);Source§impl<'a, I: Iterator, S> ShadowCountedIter<'a, I, S>
impl<'a, I: Iterator, S> ShadowCountedIter<'a, I, S>
Sourcepub fn new_nested_with<'b, T: Iterator>(
iter: I,
parent: &'a mut ShadowCountedIter<'b, T, S>,
supplement: S,
) -> Selfwhere
S: Clone,
pub fn new_nested_with<'b, T: Iterator>(
iter: I,
parent: &'a mut ShadowCountedIter<'b, T, S>,
supplement: S,
) -> Selfwhere
S: Clone,
Creates a new nested ShadowCountedIter with a reference to a parent iterator
and custom supplemental data.
Nested iterators must be either committed to propagate their count to the parent.
§Arguments
iter- The iterator to wrapparent- The parent iterator to commit the count tosupplement- Custom supplemental data for this nested iterator
§Example
use std::cell::Cell;
#[derive(Clone, Default, Debug)]
struct Counter { count: Cell<u32> }
impl Commit for Counter {
fn commit(&self, from: Self) {
self.count.set(self.count.get() + from.count.get());
}
}
let mut parent = ShadowCountedIter::new_with(
vec![1, 2].into_iter(),
Counter { count: Cell::new(10) }
);
parent.next();
let mut nested = ShadowCountedIter::new_nested_with(
vec![3, 4].into_iter(),
&mut parent,
Counter { count: Cell::new(100) }
);
assert_eq!(nested.supplement().count.get(), 100); // Custom data, not cloned from parent
while let Some(_) = nested.next() {}
nested.commit().unwrap();Source§impl<'a, I: Iterator, S: Commit> ShadowCountedIter<'a, I, S>
impl<'a, I: Iterator, S: Commit> ShadowCountedIter<'a, I, S>
Sourcepub fn commit(self) -> Result<(), Self>
pub fn commit(self) -> Result<(), Self>
Commits the count of a nested iterator to the parent iterator.
This destroys self while committing the count to the parent.
Only one child can commit to a parent in case these children got cloned.
Any further commit will result in an error. Committing to a non nested (top level)
iterator will error too. On error the iterator is returned.
§Example
let mut parent = vec![1, 2].into_iter().shadow_counted();
parent.next();
assert_eq!(parent.counter(), 1);
let mut nested = vec![3, 4].into_iter().nested_shadow_counted(&mut parent);
nested.next();
nested.next();
assert_eq!(nested.counter(), 3);
// Commit propagates count to parent
nested.commit().unwrap();
assert_eq!(parent.counter(), 3);Sourcepub fn into_inner_iter(self) -> I
pub fn into_inner_iter(self) -> I
This destructures the ShadowCountedIter and returns the iterator it wrapped.
This is useful when the counter is no longer needed but the inner iterator is and one wants
to shed the lifetime that comes with the ShadowCountedIter.
§Example
let mut iter = vec![1, 2, 3, 4, 5].into_iter().shadow_counted();
iter.next(); // consume one
let inner = iter.into_inner_iter();
assert_eq!(inner.collect::<Vec<_>>(), vec![2, 3, 4, 5]);Source§impl<I: Iterator, S> ShadowCountedIter<'_, I, S>
impl<I: Iterator, S> ShadowCountedIter<'_, I, S>
Sourcepub fn add(&mut self, delta: isize)
pub fn add(&mut self, delta: isize)
Allows to adjust the counter. This is required when in recursive structures only leafs shall be counted. Takes an isize so that it can be used with negative values.
§Arguments
delta- The delta to adjust the counter by.
§Example
let mut iter = vec![1, 2, 3].into_iter().shadow_counted();
iter.add(2);
assert_eq!(iter.counter(), 2);
iter.add(-1);
assert_eq!(iter.counter(), 1);Trait Implementations§
Source§impl<I: Iterator, S> AsRef<I> for ShadowCountedIter<'_, I, S>
impl<I: Iterator, S> AsRef<I> for ShadowCountedIter<'_, I, S>
Source§impl<'a, I: Clone + Iterator, S: Clone> Clone for ShadowCountedIter<'a, I, S>
impl<'a, I: Clone + Iterator, S: Clone> Clone for ShadowCountedIter<'a, I, S>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<I: DoubleEndedIterator, S> DoubleEndedIterator for ShadowCountedIter<'_, I, S>
Implements DoubleEndedIterator when the inner iterator does.
Both forward and backward iteration increment the counter.
impl<I: DoubleEndedIterator, S> DoubleEndedIterator for ShadowCountedIter<'_, I, S>
Implements DoubleEndedIterator when the inner iterator does.
Both forward and backward iteration increment the counter.
§Example
let mut iter = vec![1, 2, 3, 4, 5].into_iter().shadow_counted();
assert_eq!(iter.next(), Some(1));
assert_eq!(iter.counter(), 1);
assert_eq!(iter.next_back(), Some(5));
assert_eq!(iter.counter(), 2);
assert_eq!(iter.next_back(), Some(4));
assert_eq!(iter.counter(), 3);Source§fn next_back(&mut self) -> Option<Self::Item>
fn next_back(&mut self) -> Option<Self::Item>
Source§fn advance_back_by(&mut self, n: usize) -> Result<(), NonZero<usize>>
fn advance_back_by(&mut self, n: usize) -> Result<(), NonZero<usize>>
iter_advance_by)n elements. Read more1.37.0 · Source§fn nth_back(&mut self, n: usize) -> Option<Self::Item>
fn nth_back(&mut self, n: usize) -> Option<Self::Item>
nth element from the end of the iterator. Read more1.27.0 · Source§fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> R
fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> R
Iterator::try_fold(): it takes
elements starting from the back of the iterator. Read moreSource§impl<I: Iterator + ExactSizeIterator, S> ExactSizeIterator for ShadowCountedIter<'_, I, S>
Implements ExactSizeIterator when the inner iterator does.
The length reflects the remaining items in the iterator.
impl<I: Iterator + ExactSizeIterator, S> ExactSizeIterator for ShadowCountedIter<'_, I, S>
Implements ExactSizeIterator when the inner iterator does.
The length reflects the remaining items in the iterator.
§Example
let mut iter = vec![1, 2, 3, 4, 5].into_iter().shadow_counted();
assert_eq!(iter.len(), 5);
iter.next();
assert_eq!(iter.len(), 4);
iter.next();
assert_eq!(iter.len(), 3);Source§impl<T: Iterator> From<T> for ShadowCountedIter<'_, T, ()>
When types can be inferred then From and Into can be used to convert an iterator into a
ShadowCountedIter with default (unit) supplemental data.
impl<T: Iterator> From<T> for ShadowCountedIter<'_, T, ()>
When types can be inferred then From and Into can be used to convert an iterator into a
ShadowCountedIter with default (unit) supplemental data.
Source§impl<I: Iterator, S> Iterator for ShadowCountedIter<'_, I, S>
impl<I: Iterator, S> Iterator for ShadowCountedIter<'_, I, S>
Source§fn next(&mut self) -> Option<Self::Item>
fn next(&mut self) -> Option<Self::Item>
Source§fn next_chunk<const N: usize>(
&mut self,
) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where
Self: Sized,
fn next_chunk<const N: usize>(
&mut self,
) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where
Self: Sized,
iter_next_chunk)N values. Read more1.0.0 · Source§fn size_hint(&self) -> (usize, Option<usize>)
fn size_hint(&self) -> (usize, Option<usize>)
1.0.0 · Source§fn count(self) -> usizewhere
Self: Sized,
fn count(self) -> usizewhere
Self: Sized,
1.0.0 · Source§fn last(self) -> Option<Self::Item>where
Self: Sized,
fn last(self) -> Option<Self::Item>where
Self: Sized,
Source§fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>
fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>
iter_advance_by)n elements. Read more1.0.0 · Source§fn nth(&mut self, n: usize) -> Option<Self::Item>
fn nth(&mut self, n: usize) -> Option<Self::Item>
nth element of the iterator. Read more1.28.0 · Source§fn step_by(self, step: usize) -> StepBy<Self>where
Self: Sized,
fn step_by(self, step: usize) -> StepBy<Self>where
Self: Sized,
1.0.0 · Source§fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>
fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>
1.0.0 · Source§fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>where
Self: Sized,
U: IntoIterator,
fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>where
Self: Sized,
U: IntoIterator,
Source§fn intersperse(self, separator: Self::Item) -> Intersperse<Self>
fn intersperse(self, separator: Self::Item) -> Intersperse<Self>
iter_intersperse)separator between adjacent
items of the original iterator. Read moreSource§fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>
fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>
iter_intersperse)separator
between adjacent items of the original iterator. Read more1.0.0 · Source§fn map<B, F>(self, f: F) -> Map<Self, F>
fn map<B, F>(self, f: F) -> Map<Self, F>
1.0.0 · Source§fn filter<P>(self, predicate: P) -> Filter<Self, P>
fn filter<P>(self, predicate: P) -> Filter<Self, P>
1.0.0 · Source§fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>
fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>
1.0.0 · Source§fn enumerate(self) -> Enumerate<Self>where
Self: Sized,
fn enumerate(self) -> Enumerate<Self>where
Self: Sized,
1.0.0 · Source§fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
1.0.0 · Source§fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
1.57.0 · Source§fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
1.0.0 · Source§fn skip(self, n: usize) -> Skip<Self>where
Self: Sized,
fn skip(self, n: usize) -> Skip<Self>where
Self: Sized,
n elements. Read more1.0.0 · Source§fn take(self, n: usize) -> Take<Self>where
Self: Sized,
fn take(self, n: usize) -> Take<Self>where
Self: Sized,
n elements, or fewer
if the underlying iterator ends sooner. Read more1.0.0 · Source§fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
1.29.0 · Source§fn flatten(self) -> Flatten<Self>
fn flatten(self) -> Flatten<Self>
Source§fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>
fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>
iter_map_windows)f for each contiguous window of size N over
self and returns an iterator over the outputs of f. Like slice::windows(),
the windows during mapping overlap as well. Read more1.0.0 · Source§fn inspect<F>(self, f: F) -> Inspect<Self, F>
fn inspect<F>(self, f: F) -> Inspect<Self, F>
1.0.0 · Source§fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Iterator. Read moreSource§fn try_collect<B>(
&mut self,
) -> <<Self::Item as Try>::Residual as Residual<B>>::TryType
fn try_collect<B>( &mut self, ) -> <<Self::Item as Try>::Residual as Residual<B>>::TryType
iterator_try_collect)Source§fn collect_into<E>(self, collection: &mut E) -> &mut E
fn collect_into<E>(self, collection: &mut E) -> &mut E
iter_collect_into)1.0.0 · Source§fn partition<B, F>(self, f: F) -> (B, B)
fn partition<B, F>(self, f: F) -> (B, B)
Source§fn partition_in_place<'a, T, P>(self, predicate: P) -> usize
fn partition_in_place<'a, T, P>(self, predicate: P) -> usize
iter_partition_in_place)true precede all those that return false.
Returns the number of true elements found. Read moreSource§fn is_partitioned<P>(self, predicate: P) -> bool
fn is_partitioned<P>(self, predicate: P) -> bool
iter_is_partitioned)true precede all those that return false. Read more1.27.0 · Source§fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R
fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R
1.27.0 · Source§fn try_for_each<F, R>(&mut self, f: F) -> R
fn try_for_each<F, R>(&mut self, f: F) -> R
1.0.0 · Source§fn fold<B, F>(self, init: B, f: F) -> B
fn fold<B, F>(self, init: B, f: F) -> B
1.51.0 · Source§fn reduce<F>(self, f: F) -> Option<Self::Item>
fn reduce<F>(self, f: F) -> Option<Self::Item>
Source§fn try_reduce<R>(
&mut self,
f: impl FnMut(Self::Item, Self::Item) -> R,
) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType
fn try_reduce<R>( &mut self, f: impl FnMut(Self::Item, Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType
iterator_try_reduce)1.0.0 · Source§fn all<F>(&mut self, f: F) -> bool
fn all<F>(&mut self, f: F) -> bool
1.0.0 · Source§fn any<F>(&mut self, f: F) -> bool
fn any<F>(&mut self, f: F) -> bool
1.0.0 · Source§fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
1.30.0 · Source§fn find_map<B, F>(&mut self, f: F) -> Option<B>
fn find_map<B, F>(&mut self, f: F) -> Option<B>
Source§fn try_find<R>(
&mut self,
f: impl FnMut(&Self::Item) -> R,
) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType
fn try_find<R>( &mut self, f: impl FnMut(&Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType
try_find)1.0.0 · Source§fn position<P>(&mut self, predicate: P) -> Option<usize>
fn position<P>(&mut self, predicate: P) -> Option<usize>
1.0.0 · Source§fn rposition<P>(&mut self, predicate: P) -> Option<usize>
fn rposition<P>(&mut self, predicate: P) -> Option<usize>
1.0.0 · Source§fn max(self) -> Option<Self::Item>
fn max(self) -> Option<Self::Item>
1.0.0 · Source§fn min(self) -> Option<Self::Item>
fn min(self) -> Option<Self::Item>
1.6.0 · Source§fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>
fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>
1.15.0 · Source§fn max_by<F>(self, compare: F) -> Option<Self::Item>
fn max_by<F>(self, compare: F) -> Option<Self::Item>
1.6.0 · Source§fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>
fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>
1.15.0 · Source§fn min_by<F>(self, compare: F) -> Option<Self::Item>
fn min_by<F>(self, compare: F) -> Option<Self::Item>
1.0.0 · Source§fn rev(self) -> Rev<Self>where
Self: Sized + DoubleEndedIterator,
fn rev(self) -> Rev<Self>where
Self: Sized + DoubleEndedIterator,
1.0.0 · Source§fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
1.36.0 · Source§fn copied<'a, T>(self) -> Copied<Self>
fn copied<'a, T>(self) -> Copied<Self>
Source§fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>where
Self: Sized,
fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>where
Self: Sized,
iter_array_chunks)N elements of the iterator at a time. Read more1.11.0 · Source§fn product<P>(self) -> P
fn product<P>(self) -> P
Source§fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering
fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering
iter_order_by)Iterator with those
of another with respect to the specified comparison function. Read more1.5.0 · Source§fn partial_cmp<I>(self, other: I) -> Option<Ordering>
fn partial_cmp<I>(self, other: I) -> Option<Ordering>
PartialOrd elements of
this Iterator with those of another. The comparison works like short-circuit
evaluation, returning a result without comparing the remaining elements.
As soon as an order can be determined, the evaluation stops and a result is returned. Read moreSource§fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>where
Self: Sized,
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>where
Self: Sized,
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
iter_order_by)Iterator with those
of another with respect to the specified comparison function. Read moreSource§fn eq_by<I, F>(self, other: I, eq: F) -> bool
fn eq_by<I, F>(self, other: I, eq: F) -> bool
iter_order_by)1.5.0 · Source§fn lt<I>(self, other: I) -> bool
fn lt<I>(self, other: I) -> bool
Iterator are lexicographically
less than those of another. Read more1.5.0 · Source§fn le<I>(self, other: I) -> bool
fn le<I>(self, other: I) -> bool
Iterator are lexicographically
less or equal to those of another. Read more1.5.0 · Source§fn gt<I>(self, other: I) -> bool
fn gt<I>(self, other: I) -> bool
Iterator are lexicographically
greater than those of another. Read more1.5.0 · Source§fn ge<I>(self, other: I) -> bool
fn ge<I>(self, other: I) -> bool
Iterator are lexicographically
greater than or equal to those of another. Read more