src/libcore/iter/sources.rs

   1 // Copyright 2013-2016 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use clone::Clone;
  12 use default::Default;
  13 use fmt;
  14 use marker;
  15 use option::Option::{self, Some, None};
  16 use usize;
  17
  18 use super::{DoubleEndedIterator, IntoIterator, Iterator, ExactSizeIterator, FusedIterator};
  19
  20 /// An iterator that repeats an element endlessly.
  21 ///
  22 /// This `struct` is created by the [`repeat()`] function. See its documentation for more.
  23 ///
  24 /// [`repeat()`]: fn.repeat.html
  25 #[derive(Clone, Debug)]
  26 #[stable(feature = "rust1", since = "1.0.0")]
  27 pub struct Repeat<A> {
  28     element: A
  29 }
  30
  31 #[stable(feature = "rust1", since = "1.0.0")]
  32 impl<A: Clone> Iterator for Repeat<A> {
  33     type Item = A;
  34
  35     #[inline]
  36     fn next(&mut self) -> Option<A> { Some(self.element.clone()) }
  37     #[inline]
  38     fn size_hint(&self) -> (usize, Option<usize>) { (usize::MAX, None) }
  39 }
  40
  41 #[stable(feature = "rust1", since = "1.0.0")]
  42 impl<A: Clone> DoubleEndedIterator for Repeat<A> {
  43     #[inline]
  44     fn next_back(&mut self) -> Option<A> { Some(self.element.clone()) }
  45 }
  46
  47 #[unstable(feature = "fused", issue = "35602")]
  48 impl<A: Clone> FusedIterator for Repeat<A> {}
  49
  50 /// Creates a new iterator that endlessly repeats a single element.
  51 ///
  52 /// The `repeat()` function repeats a single value over and over and over and
  53 /// over and over and 🔁.
  54 ///
  55 /// Infinite iterators like `repeat()` are often used with adapters like
  56 /// [`take()`], in order to make them finite.
  57 ///
  58 /// [`take()`]: trait.Iterator.html#method.take
  59 ///
  60 /// # Examples
  61 ///
  62 /// Basic usage:
  63 ///
  64 /// ```
  65 /// use std::iter;
  66 ///
  67 /// // the number four 4ever:
  68 /// let mut fours = iter::repeat(4);
  69 ///
  70 /// assert_eq!(Some(4), fours.next());
  71 /// assert_eq!(Some(4), fours.next());
  72 /// assert_eq!(Some(4), fours.next());
  73 /// assert_eq!(Some(4), fours.next());
  74 /// assert_eq!(Some(4), fours.next());
  75 ///
  76 /// // yup, still four
  77 /// assert_eq!(Some(4), fours.next());
  78 /// ```
  79 ///
  80 /// Going finite with [`take()`]:
  81 ///
  82 /// ```
  83 /// use std::iter;
  84 ///
  85 /// // that last example was too many fours. Let's only have four fours.
  86 /// let mut four_fours = iter::repeat(4).take(4);
  87 ///
  88 /// assert_eq!(Some(4), four_fours.next());
  89 /// assert_eq!(Some(4), four_fours.next());
  90 /// assert_eq!(Some(4), four_fours.next());
  91 /// assert_eq!(Some(4), four_fours.next());
  92 ///
  93 /// // ... and now we're done
  94 /// assert_eq!(None, four_fours.next());
  95 /// ```
  96 #[inline]
  97 #[stable(feature = "rust1", since = "1.0.0")]
  98 pub fn repeat<T: Clone>(elt: T) -> Repeat<T> {
  99     Repeat{element: elt}
 100 }
 101
 102 /// An iterator that yields nothing.
 103 ///
 104 /// This `struct` is created by the [`empty()`] function. See its documentation for more.
 105 ///
 106 /// [`empty()`]: fn.empty.html
 107 #[stable(feature = "iter_empty", since = "1.2.0")]
 108 pub struct Empty<T>(marker::PhantomData<T>);
 109
 110 #[stable(feature = "core_impl_debug", since = "1.9.0")]
 111 impl<T> fmt::Debug for Empty<T> {
 112     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 113         f.pad("Empty")
 114     }
 115 }
 116
 117 #[stable(feature = "iter_empty", since = "1.2.0")]
 118 impl<T> Iterator for Empty<T> {
 119     type Item = T;
 120
 121     fn next(&mut self) -> Option<T> {
 122         None
 123     }
 124
 125     fn size_hint(&self) -> (usize, Option<usize>){
 126         (0, Some(0))
 127     }
 128 }
 129
 130 #[stable(feature = "iter_empty", since = "1.2.0")]
 131 impl<T> DoubleEndedIterator for Empty<T> {
 132     fn next_back(&mut self) -> Option<T> {
 133         None
 134     }
 135 }
 136
 137 #[stable(feature = "iter_empty", since = "1.2.0")]
 138 impl<T> ExactSizeIterator for Empty<T> {
 139     fn len(&self) -> usize {
 140         0
 141     }
 142 }
 143
 144 #[unstable(feature = "fused", issue = "35602")]
 145 impl<T> FusedIterator for Empty<T> {}
 146
 147 // not #[derive] because that adds a Clone bound on T,
 148 // which isn't necessary.
 149 #[stable(feature = "iter_empty", since = "1.2.0")]
 150 impl<T> Clone for Empty<T> {
 151     fn clone(&self) -> Empty<T> {
 152         Empty(marker::PhantomData)
 153     }
 154 }
 155
 156 // not #[derive] because that adds a Default bound on T,
 157 // which isn't necessary.
 158 #[stable(feature = "iter_empty", since = "1.2.0")]
 159 impl<T> Default for Empty<T> {
 160     fn default() -> Empty<T> {
 161         Empty(marker::PhantomData)
 162     }
 163 }
 164
 165 /// Creates an iterator that yields nothing.
 166 ///
 167 /// # Examples
 168 ///
 169 /// Basic usage:
 170 ///
 171 /// ```
 172 /// use std::iter;
 173 ///
 174 /// // this could have been an iterator over i32, but alas, it's just not.
 175 /// let mut nope = iter::empty::<i32>();
 176 ///
 177 /// assert_eq!(None, nope.next());
 178 /// ```
 179 #[stable(feature = "iter_empty", since = "1.2.0")]
 180 pub fn empty<T>() -> Empty<T> {
 181     Empty(marker::PhantomData)
 182 }
 183
 184 /// An iterator that yields an element exactly once.
 185 ///
 186 /// This `struct` is created by the [`once()`] function. See its documentation for more.
 187 ///
 188 /// [`once()`]: fn.once.html
 189 #[derive(Clone, Debug)]
 190 #[stable(feature = "iter_once", since = "1.2.0")]
 191 pub struct Once<T> {
 192     inner: ::option::IntoIter<T>
 193 }
 194
 195 #[stable(feature = "iter_once", since = "1.2.0")]
 196 impl<T> Iterator for Once<T> {
 197     type Item = T;
 198
 199     fn next(&mut self) -> Option<T> {
 200         self.inner.next()
 201     }
 202
 203     fn size_hint(&self) -> (usize, Option<usize>) {
 204         self.inner.size_hint()
 205     }
 206 }
 207
 208 #[stable(feature = "iter_once", since = "1.2.0")]
 209 impl<T> DoubleEndedIterator for Once<T> {
 210     fn next_back(&mut self) -> Option<T> {
 211         self.inner.next_back()
 212     }
 213 }
 214
 215 #[stable(feature = "iter_once", since = "1.2.0")]
 216 impl<T> ExactSizeIterator for Once<T> {
 217     fn len(&self) -> usize {
 218         self.inner.len()
 219     }
 220 }
 221
 222 #[unstable(feature = "fused", issue = "35602")]
 223 impl<T> FusedIterator for Once<T> {}
 224
 225 /// Creates an iterator that yields an element exactly once.
 226 ///
 227 /// This is commonly used to adapt a single value into a [`chain()`] of other
 228 /// kinds of iteration. Maybe you have an iterator that covers almost
 229 /// everything, but you need an extra special case. Maybe you have a function
 230 /// which works on iterators, but you only need to process one value.
 231 ///
 232 /// [`chain()`]: trait.Iterator.html#method.chain
 233 ///
 234 /// # Examples
 235 ///
 236 /// Basic usage:
 237 ///
 238 /// ```
 239 /// use std::iter;
 240 ///
 241 /// // one is the loneliest number
 242 /// let mut one = iter::once(1);
 243 ///
 244 /// assert_eq!(Some(1), one.next());
 245 ///
 246 /// // just one, that's all we get
 247 /// assert_eq!(None, one.next());
 248 /// ```
 249 ///
 250 /// Chaining together with another iterator. Let's say that we want to iterate
 251 /// over each file of the `.foo` directory, but also a configuration file,
 252 /// `.foorc`:
 253 ///
 254 /// ```no_run
 255 /// use std::iter;
 256 /// use std::fs;
 257 /// use std::path::PathBuf;
 258 ///
 259 /// let dirs = fs::read_dir(".foo").unwrap();
 260 ///
 261 /// // we need to convert from an iterator of DirEntry-s to an iterator of
 262 /// // PathBufs, so we use map
 263 /// let dirs = dirs.map(|file| file.unwrap().path());
 264 ///
 265 /// // now, our iterator just for our config file
 266 /// let config = iter::once(PathBuf::from(".foorc"));
 267 ///
 268 /// // chain the two iterators together into one big iterator
 269 /// let files = dirs.chain(config);
 270 ///
 271 /// // this will give us all of the files in .foo as well as .foorc
 272 /// for f in files {
 273 ///     println!("{:?}", f);
 274 /// }
 275 /// ```
 276 #[stable(feature = "iter_once", since = "1.2.0")]
 277 pub fn once<T>(value: T) -> Once<T> {
 278     Once { inner: Some(value).into_iter() }
 279 }