sources.rs.html -- source
Description: Source to the Rust file `libcore/iter/sources.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
    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
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388

    // Copyright 2013-2016 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    use fmt;
    use marker;
    use usize;

    use super::{FusedIterator, TrustedLen};

    /// An iterator that repeats an element endlessly.
    ///
    /// This `struct` is created by the [`repeat`] function. See its documentation for more.
    ///
    /// [`repeat`]: fn.repeat.html
    #[derive(Clone, Debug)]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub struct Repeat<A> {
        element: A
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<A: Clone> Iterator for Repeat<A> {
        type Item = A;

        #[inline]
        fn next(&mut self) -> Option<A> { Some(self.element.clone()) }
        #[inline]
        fn size_hint(&self) -> (usize, Option<usize>) { (usize::MAX, None) }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<A: Clone> DoubleEndedIterator for Repeat<A> {
        #[inline]
        fn next_back(&mut self) -> Option<A> { Some(self.element.clone()) }
    }

    #[stable(feature = "fused", since = "1.26.0")]
    impl<A: Clone> FusedIterator for Repeat<A> {}

    #[unstable(feature = "trusted_len", issue = "37572")]
    unsafe impl<A: Clone> TrustedLen for Repeat<A> {}

    /// Creates a new iterator that endlessly repeats a single element.
    ///
    /// The `repeat()` function repeats a single value over and over and over and
    /// over and over and 🔁.
    ///
    /// Infinite iterators like `repeat()` are often used with adapters like
    /// [`take`], in order to make them finite.
    ///
    /// [`take`]: trait.Iterator.html#method.take
    ///
    /// If the element type of the iterator you need does not implement `Clone`,
    /// or if you do not want to keep the repeated element in memory, you can
    /// instead use the [`repeat_with`] function.
    ///
    /// [`repeat_with`]: fn.repeat_with.html
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// use std::iter;
    ///
    /// // the number four 4ever:
    /// let mut fours = iter::repeat(4);
    ///
    /// assert_eq!(Some(4), fours.next());
    /// assert_eq!(Some(4), fours.next());
    /// assert_eq!(Some(4), fours.next());
    /// assert_eq!(Some(4), fours.next());
    /// assert_eq!(Some(4), fours.next());
    ///
    /// // yup, still four
    /// assert_eq!(Some(4), fours.next());
    /// ```
    ///
    /// Going finite with [`take`]:
    ///
    /// ```
    /// use std::iter;
    ///
    /// // that last example was too many fours. Let's only have four fours.
    /// let mut four_fours = iter::repeat(4).take(4);
    ///
    /// assert_eq!(Some(4), four_fours.next());
    /// assert_eq!(Some(4), four_fours.next());
    /// assert_eq!(Some(4), four_fours.next());
    /// assert_eq!(Some(4), four_fours.next());
    ///
    /// // ... and now we're done
    /// assert_eq!(None, four_fours.next());
    /// ```
    #[inline]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub fn repeat<T: Clone>(elt: T) -> Repeat<T> {
        Repeat{element: elt}
    }

    /// 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.
    ///
    /// [`repeat_with`]: fn.repeat_with.html
    #[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> {}

    /// 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 and over and
    /// over and over and 🔁.
    ///
    /// Infinite iterators like `repeat_with()` are often used with adapters like
    /// [`take`], in order to make them finite.
    ///
    /// [`take`]: trait.Iterator.html#method.take
    ///
    /// 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.
    ///
    /// [`repeat`]: fn.repeat.html
    ///
    /// 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.
    ///
    /// # 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 yields nothing.
    ///
    /// This `struct` is created by the [`empty`] function. See its documentation for more.
    ///
    /// [`empty`]: fn.empty.html
    #[stable(feature = "iter_empty", since = "1.2.0")]
    pub struct Empty<T>(marker::PhantomData<T>);

    #[stable(feature = "core_impl_debug", since = "1.9.0")]
    impl<T> fmt::Debug for Empty<T> {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            f.pad("Empty")
        }
    }

    #[stable(feature = "iter_empty", since = "1.2.0")]
    impl<T> Iterator for Empty<T> {
        type Item = T;

        fn next(&mut self) -> Option<T> {
            None
        }

        fn size_hint(&self) -> (usize, Option<usize>){
            (0, Some(0))
        }
    }

    #[stable(feature = "iter_empty", since = "1.2.0")]
    impl<T> DoubleEndedIterator for Empty<T> {
        fn next_back(&mut self) -> Option<T> {
            None
        }
    }

    #[stable(feature = "iter_empty", since = "1.2.0")]
    impl<T> ExactSizeIterator for Empty<T> {
        fn len(&self) -> usize {
            0
        }
    }

    #[unstable(feature = "trusted_len", issue = "37572")]
    unsafe impl<T> TrustedLen for Empty<T> {}

    #[stable(feature = "fused", since = "1.26.0")]
    impl<T> FusedIterator for Empty<T> {}

    // not #[derive] because that adds a Clone bound on T,
    // which isn't necessary.
    #[stable(feature = "iter_empty", since = "1.2.0")]
    impl<T> Clone for Empty<T> {
        fn clone(&self) -> Empty<T> {
            Empty(marker::PhantomData)
        }
    }

    // not #[derive] because that adds a Default bound on T,
    // which isn't necessary.
    #[stable(feature = "iter_empty", since = "1.2.0")]
    impl<T> Default for Empty<T> {
        fn default() -> Empty<T> {
            Empty(marker::PhantomData)
        }
    }

    /// Creates an iterator that yields nothing.
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// use std::iter;
    ///
    /// // this could have been an iterator over i32, but alas, it's just not.
    /// let mut nope = iter::empty::<i32>();
    ///
    /// assert_eq!(None, nope.next());
    /// ```
    #[stable(feature = "iter_empty", since = "1.2.0")]
    pub fn empty<T>() -> Empty<T> {
        Empty(marker::PhantomData)
    }

    /// An iterator that yields an element exactly once.
    ///
    /// This `struct` is created by the [`once`] function. See its documentation for more.
    ///
    /// [`once`]: fn.once.html
    #[derive(Clone, Debug)]
    #[stable(feature = "iter_once", since = "1.2.0")]
    pub struct Once<T> {
        inner: ::option::IntoIter<T>
    }

    #[stable(feature = "iter_once", since = "1.2.0")]
    impl<T> Iterator for Once<T> {
        type Item = T;

        fn next(&mut self) -> Option<T> {
            self.inner.next()
        }

        fn size_hint(&self) -> (usize, Option<usize>) {
            self.inner.size_hint()
        }
    }

    #[stable(feature = "iter_once", since = "1.2.0")]
    impl<T> DoubleEndedIterator for Once<T> {
        fn next_back(&mut self) -> Option<T> {
            self.inner.next_back()
        }
    }

    #[stable(feature = "iter_once", since = "1.2.0")]
    impl<T> ExactSizeIterator for Once<T> {
        fn len(&self) -> usize {
            self.inner.len()
        }
    }

    #[unstable(feature = "trusted_len", issue = "37572")]
    unsafe impl<T> TrustedLen for Once<T> {}

    #[stable(feature = "fused", since = "1.26.0")]
    impl<T> FusedIterator for Once<T> {}

    /// Creates an iterator that yields an element exactly once.
    ///
    /// This is commonly used to adapt a single value into a [`chain`] of other
    /// kinds of iteration. Maybe you have an iterator that covers almost
    /// everything, but you need an extra special case. Maybe you have a function
    /// which works on iterators, but you only need to process one value.
    ///
    /// [`chain`]: trait.Iterator.html#method.chain
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// use std::iter;
    ///
    /// // one is the loneliest number
    /// let mut one = iter::once(1);
    ///
    /// assert_eq!(Some(1), one.next());
    ///
    /// // just one, that's all we get
    /// assert_eq!(None, one.next());
    /// ```
    ///
    /// Chaining together with another iterator. Let's say that we want to iterate
    /// over each file of the `.foo` directory, but also a configuration file,
    /// `.foorc`:
    ///
    /// ```no_run
    /// use std::iter;
    /// use std::fs;
    /// use std::path::PathBuf;
    ///
    /// let dirs = fs::read_dir(".foo").unwrap();
    ///
    /// // we need to convert from an iterator of DirEntry-s to an iterator of
    /// // PathBufs, so we use map
    /// let dirs = dirs.map(|file| file.unwrap().path());
    ///
    /// // now, our iterator just for our config file
    /// let config = iter::once(PathBuf::from(".foorc"));
    ///
    /// // chain the two iterators together into one big iterator
    /// let files = dirs.chain(config);
    ///
    /// // this will give us all of the files in .foo as well as .foorc
    /// for f in files {
    ///     println!("{:?}", f);
    /// }
    /// ```
    #[stable(feature = "iter_once", since = "1.2.0")]
    pub fn once<T>(value: T) -> Once<T> {
        Once { inner: Some(value).into_iter() }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)