inspect.rs - source
Description: Source of the Rust file `library/core/src/iter/adapters/inspect.rs`.
Keywords: rust, rustlang, rust-lang

      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

    use crate::fmt;
    use crate::iter::{adapters::SourceIter, FusedIterator, InPlaceIterable};
    use crate::ops::Try;

    /// An iterator that calls a function with a reference to each element before
    /// yielding it.
    ///
    /// This `struct` is created by the [`inspect`] method on [`Iterator`]. See its
    /// documentation for more.
    ///
    /// [`inspect`]: Iterator::inspect
    /// [`Iterator`]: trait.Iterator.html
    #[must_use = "iterators are lazy and do nothing unless consumed"]
    #[stable(feature = "rust1", since = "1.0.0")]
    #[derive(Clone)]
    pub struct Inspect<I, F> {
        iter: I,
        f: F,
    }
    impl<I, F> Inspect<I, F> {
        pub(in crate::iter) fn new(iter: I, f: F) -> Inspect<I, F> {
            Inspect { iter, f }
        }
    }

    #[stable(feature = "core_impl_debug", since = "1.9.0")]
    impl<I: fmt::Debug, F> fmt::Debug for Inspect<I, F> {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            f.debug_struct("Inspect").field("iter", &self.iter).finish()
        }
    }

    impl<I: Iterator, F> Inspect<I, F>
    where
        F: FnMut(&I::Item),
    {
        #[inline]
        fn do_inspect(&mut self, elt: Option<I::Item>) -> Option<I::Item> {
            if let Some(ref a) = elt {
                (self.f)(a);
            }

            elt
        }
    }

    fn inspect_fold<T, Acc>(
        mut f: impl FnMut(&T),
        mut fold: impl FnMut(Acc, T) -> Acc,
    ) -> impl FnMut(Acc, T) -> Acc {
        move |acc, item| {
            f(&item);
            fold(acc, item)
        }
    }

    fn inspect_try_fold<'a, T, Acc, R>(
        f: &'a mut impl FnMut(&T),
        mut fold: impl FnMut(Acc, T) -> R + 'a,
    ) -> impl FnMut(Acc, T) -> R + 'a {
        move |acc, item| {
            f(&item);
            fold(acc, item)
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<I: Iterator, F> Iterator for Inspect<I, F>
    where
        F: FnMut(&I::Item),
    {
        type Item = I::Item;

        #[inline]
        fn next(&mut self) -> Option<I::Item> {
            let next = self.iter.next();
            self.do_inspect(next)
        }

        #[inline]
        fn size_hint(&self) -> (usize, Option<usize>) {
            self.iter.size_hint()
        }

        #[inline]
        fn try_fold<Acc, Fold, R>(&mut self, init: Acc, fold: Fold) -> R
        where
            Self: Sized,
            Fold: FnMut(Acc, Self::Item) -> R,
            R: Try<Ok = Acc>,
        {
            self.iter.try_fold(init, inspect_try_fold(&mut self.f, fold))
        }

        #[inline]
        fn fold<Acc, Fold>(self, init: Acc, fold: Fold) -> Acc
        where
            Fold: FnMut(Acc, Self::Item) -> Acc,
        {
            self.iter.fold(init, inspect_fold(self.f, fold))
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<I: DoubleEndedIterator, F> DoubleEndedIterator for Inspect<I, F>
    where
        F: FnMut(&I::Item),
    {
        #[inline]
        fn next_back(&mut self) -> Option<I::Item> {
            let next = self.iter.next_back();
            self.do_inspect(next)
        }

        #[inline]
        fn try_rfold<Acc, Fold, R>(&mut self, init: Acc, fold: Fold) -> R
        where
            Self: Sized,
            Fold: FnMut(Acc, Self::Item) -> R,
            R: Try<Ok = Acc>,
        {
            self.iter.try_rfold(init, inspect_try_fold(&mut self.f, fold))
        }

        #[inline]
        fn rfold<Acc, Fold>(self, init: Acc, fold: Fold) -> Acc
        where
            Fold: FnMut(Acc, Self::Item) -> Acc,
        {
            self.iter.rfold(init, inspect_fold(self.f, fold))
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<I: ExactSizeIterator, F> ExactSizeIterator for Inspect<I, F>
    where
        F: FnMut(&I::Item),
    {
        fn len(&self) -> usize {
            self.iter.len()
        }

        fn is_empty(&self) -> bool {
            self.iter.is_empty()
        }
    }

    #[stable(feature = "fused", since = "1.26.0")]
    impl<I: FusedIterator, F> FusedIterator for Inspect<I, F> where F: FnMut(&I::Item) {}

    #[unstable(issue = "none", feature = "inplace_iteration")]
    unsafe impl<S: Iterator, I: Iterator, F> SourceIter for Inspect<I, F>
    where
        F: FnMut(&I::Item),
        I: SourceIter<Source = S>,
    {
        type Source = S;

        #[inline]
        unsafe fn as_inner(&mut self) -> &mut S {
            // SAFETY: unsafe function forwarding to unsafe function with the same requirements
            unsafe { SourceIter::as_inner(&mut self.iter) }
        }
    }

    #[unstable(issue = "none", feature = "inplace_iteration")]
    unsafe impl<I: InPlaceIterable, F> InPlaceIterable for Inspect<I, F> where F: FnMut(&I::Item) {}