repeat_with.rs - source
Description: Source of the Rust file `library/core/src/iter/sources/repeat_with.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

    use crate::iter::{FusedIterator, TrustedLen};

    /// Creates a new iterator that repeats elements of type `A` endlessly by
    /// applying the provided closure, the repeater, `F: FnMut() -> A`.
    ///
    /// The `repeat_with()` function calls the repeater over and over again.
    ///
    /// Infinite iterators like `repeat_with()` are often used with adapters like
    /// [`Iterator::take()`], in order to make them finite.
    ///
    /// If the element type of the iterator you need implements [`Clone`], and
    /// it is OK to keep the source element in memory, you should instead use
    /// the [`repeat()`] function.
    ///
    /// An iterator produced by `repeat_with()` is not a [`DoubleEndedIterator`].
    /// If you need `repeat_with()` to return a [`DoubleEndedIterator`],
    /// please open a GitHub issue explaining your use case.
    ///
    /// [`repeat()`]: crate::iter::repeat
    /// [`DoubleEndedIterator`]: crate::iter::DoubleEndedIterator
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// use std::iter;
    ///
    /// // let's assume we have some value of a type that is not `Clone`
    /// // or which don't want to have in memory just yet because it is expensive:
    /// #[derive(PartialEq, Debug)]
    /// struct Expensive;
    ///
    /// // a particular value forever:
    /// let mut things = iter::repeat_with(|| Expensive);
    ///
    /// assert_eq!(Some(Expensive), things.next());
    /// assert_eq!(Some(Expensive), things.next());
    /// assert_eq!(Some(Expensive), things.next());
    /// assert_eq!(Some(Expensive), things.next());
    /// assert_eq!(Some(Expensive), things.next());
    /// ```
    ///
    /// Using mutation and going finite:
    ///
    /// ```rust
    /// use std::iter;
    ///
    /// // From the zeroth to the third power of two:
    /// let mut curr = 1;
    /// let mut pow2 = iter::repeat_with(|| { let tmp = curr; curr *= 2; tmp })
    ///                     .take(4);
    ///
    /// assert_eq!(Some(1), pow2.next());
    /// assert_eq!(Some(2), pow2.next());
    /// assert_eq!(Some(4), pow2.next());
    /// assert_eq!(Some(8), pow2.next());
    ///
    /// // ... and now we're done
    /// assert_eq!(None, pow2.next());
    /// ```
    #[inline]
    #[stable(feature = "iterator_repeat_with", since = "1.28.0")]
    pub fn repeat_with<A, F: FnMut() -> A>(repeater: F) -> RepeatWith<F> {
        RepeatWith { repeater }
    }

    /// An iterator that repeats elements of type `A` endlessly by
    /// applying the provided closure `F: FnMut() -> A`.
    ///
    /// This `struct` is created by the [`repeat_with()`] function.
    /// See its documentation for more.
    #[derive(Copy, Clone, Debug)]
    #[stable(feature = "iterator_repeat_with", since = "1.28.0")]
    pub struct RepeatWith<F> {
        repeater: F,
    }

    #[stable(feature = "iterator_repeat_with", since = "1.28.0")]
    impl<A, F: FnMut() -> A> Iterator for RepeatWith<F> {
        type Item = A;

        #[inline]
        fn next(&mut self) -> Option<A> {
            Some((self.repeater)())
        }

        #[inline]
        fn size_hint(&self) -> (usize, Option<usize>) {
            (usize::MAX, None)
        }
    }

    #[stable(feature = "iterator_repeat_with", since = "1.28.0")]
    impl<A, F: FnMut() -> A> FusedIterator for RepeatWith<F> {}

    #[unstable(feature = "trusted_len", issue = "37572")]
    unsafe impl<A, F: FnMut() -> A> TrustedLen for RepeatWith<F> {}