src/libcore/option.rs

   1 //! Optional values.
   2 //!
   3 //! Type [`Option`] represents an optional value: every [`Option`]
   4 //! is either [`Some`] and contains a value, or [`None`], and
   5 //! does not. [`Option`] types are very common in Rust code, as
   6 //! they have a number of uses:
   7 //!
   8 //! * Initial values
   9 //! * Return values for functions that are not defined
  10 //!   over their entire input range (partial functions)
  11 //! * Return value for otherwise reporting simple errors, where `None` is
  12 //!   returned on error
  13 //! * Optional struct fields
  14 //! * Struct fields that can be loaned or "taken"
  15 //! * Optional function arguments
  16 //! * Nullable pointers
  17 //! * Swapping things out of difficult situations
  18 //!
  19 //! [`Option`]s are commonly paired with pattern matching to query the presence
  20 //! of a value and take action, always accounting for the [`None`] case.
  21 //!
  22 //! ```
  23 //! fn divide(numerator: f64, denominator: f64) -> Option<f64> {
  24 //!     if denominator == 0.0 {
  25 //!         None
  26 //!     } else {
  27 //!         Some(numerator / denominator)
  28 //!     }
  29 //! }
  30 //!
  31 //! // The return value of the function is an option
  32 //! let result = divide(2.0, 3.0);
  33 //!
  34 //! // Pattern match to retrieve the value
  35 //! match result {
  36 //!     // The division was valid
  37 //!     Some(x) => println!("Result: {}", x),
  38 //!     // The division was invalid
  39 //!     None    => println!("Cannot divide by 0"),
  40 //! }
  41 //! ```
  42 //!
  43 //
  44 // FIXME: Show how `Option` is used in practice, with lots of methods
  45 //
  46 //! # Options and pointers ("nullable" pointers)
  47 //!
  48 //! Rust's pointer types must always point to a valid location; there are
  49 //! no "null" pointers. Instead, Rust has *optional* pointers, like
  50 //! the optional owned box, [`Option`]`<`[`Box<T>`]`>`.
  51 //!
  52 //! The following example uses [`Option`] to create an optional box of
  53 //! [`i32`]. Notice that in order to use the inner [`i32`] value first, the
  54 //! `check_optional` function needs to use pattern matching to
  55 //! determine whether the box has a value (i.e., it is [`Some(...)`][`Some`]) or
  56 //! not ([`None`]).
  57 //!
  58 //! ```
  59 //! let optional = None;
  60 //! check_optional(optional);
  61 //!
  62 //! let optional = Some(Box::new(9000));
  63 //! check_optional(optional);
  64 //!
  65 //! fn check_optional(optional: Option<Box<i32>>) {
  66 //!     match optional {
  67 //!         Some(ref p) => println!("has value {}", p),
  68 //!         None => println!("has no value"),
  69 //!     }
  70 //! }
  71 //! ```
  72 //!
  73 //! This usage of [`Option`] to create safe nullable pointers is so
  74 //! common that Rust does special optimizations to make the
  75 //! representation of [`Option`]`<`[`Box<T>`]`>` a single pointer. Optional pointers
  76 //! in Rust are stored as efficiently as any other pointer type.
  77 //!
  78 //! # Examples
  79 //!
  80 //! Basic pattern matching on [`Option`]:
  81 //!
  82 //! ```
  83 //! let msg = Some("howdy");
  84 //!
  85 //! // Take a reference to the contained string
  86 //! if let Some(ref m) = msg {
  87 //!     println!("{}", *m);
  88 //! }
  89 //!
  90 //! // Remove the contained string, destroying the Option
  91 //! let unwrapped_msg = msg.unwrap_or("default message");
  92 //! ```
  93 //!
  94 //! Initialize a result to [`None`] before a loop:
  95 //!
  96 //! ```
  97 //! enum Kingdom { Plant(u32, &'static str), Animal(u32, &'static str) }
  98 //!
  99 //! // A list of data to search through.
 100 //! let all_the_big_things = [
 101 //!     Kingdom::Plant(250, "redwood"),
 102 //!     Kingdom::Plant(230, "noble fir"),
 103 //!     Kingdom::Plant(229, "sugar pine"),
 104 //!     Kingdom::Animal(25, "blue whale"),
 105 //!     Kingdom::Animal(19, "fin whale"),
 106 //!     Kingdom::Animal(15, "north pacific right whale"),
 107 //! ];
 108 //!
 109 //! // We're going to search for the name of the biggest animal,
 110 //! // but to start with we've just got `None`.
 111 //! let mut name_of_biggest_animal = None;
 112 //! let mut size_of_biggest_animal = 0;
 113 //! for big_thing in &all_the_big_things {
 114 //!     match *big_thing {
 115 //!         Kingdom::Animal(size, name) if size > size_of_biggest_animal => {
 116 //!             // Now we've found the name of some big animal
 117 //!             size_of_biggest_animal = size;
 118 //!             name_of_biggest_animal = Some(name);
 119 //!         }
 120 //!         Kingdom::Animal(..) | Kingdom::Plant(..) => ()
 121 //!     }
 122 //! }
 123 //!
 124 //! match name_of_biggest_animal {
 125 //!     Some(name) => println!("the biggest animal is {}", name),
 126 //!     None => println!("there are no animals :("),
 127 //! }
 128 //! ```
 129 //!
 130 //! [`Option`]: enum.Option.html
 131 //! [`Some`]: enum.Option.html#variant.Some
 132 //! [`None`]: enum.Option.html#variant.None
 133 //! [`Box<T>`]: ../../std/boxed/struct.Box.html
 134 //! [`i32`]: ../../std/primitive.i32.html
 135
 136 #![stable(feature = "rust1", since = "1.0.0")]
 137
 138 use iter::{FromIterator, FusedIterator, TrustedLen};
 139 use {hint, mem, ops::{self, Deref}};
 140 use pin::Pin;
 141
 142 // Note that this is not a lang item per se, but it has a hidden dependency on
 143 // `Iterator`, which is one. The compiler assumes that the `next` method of
 144 // `Iterator` is an enumeration with one type parameter and two variants,
 145 // which basically means it must be `Option`.
 146
 147 /// The `Option` type. See [the module level documentation](index.html) for more.
 148 #[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Debug, Hash)]
 149 #[stable(feature = "rust1", since = "1.0.0")]
 150 pub enum Option<T> {
 151     /// No value
 152     #[stable(feature = "rust1", since = "1.0.0")]
 153     None,
 154     /// Some value `T`
 155     #[stable(feature = "rust1", since = "1.0.0")]
 156     Some(#[stable(feature = "rust1", since = "1.0.0")] T),
 157 }
 158
 159 /////////////////////////////////////////////////////////////////////////////
 160 // Type implementation
 161 /////////////////////////////////////////////////////////////////////////////
 162
 163 impl<T> Option<T> {
 164     /////////////////////////////////////////////////////////////////////////
 165     // Querying the contained values
 166     /////////////////////////////////////////////////////////////////////////
 167
 168     /// Returns `true` if the option is a [`Some`] value.
 169     ///
 170     /// # Examples
 171     ///
 172     /// ```
 173     /// let x: Option<u32> = Some(2);
 174     /// assert_eq!(x.is_some(), true);
 175     ///
 176     /// let x: Option<u32> = None;
 177     /// assert_eq!(x.is_some(), false);
 178     /// ```
 179     ///
 180     /// [`Some`]: #variant.Some
 181     #[inline]
 182     #[stable(feature = "rust1", since = "1.0.0")]
 183     pub fn is_some(&self) -> bool {
 184         match *self {
 185             Some(_) => true,
 186             None => false,
 187         }
 188     }
 189
 190     /// Returns `true` if the option is a [`None`] value.
 191     ///
 192     /// # Examples
 193     ///
 194     /// ```
 195     /// let x: Option<u32> = Some(2);
 196     /// assert_eq!(x.is_none(), false);
 197     ///
 198     /// let x: Option<u32> = None;
 199     /// assert_eq!(x.is_none(), true);
 200     /// ```
 201     ///
 202     /// [`None`]: #variant.None
 203     #[inline]
 204     #[stable(feature = "rust1", since = "1.0.0")]
 205     pub fn is_none(&self) -> bool {
 206         !self.is_some()
 207     }
 208
 209     /////////////////////////////////////////////////////////////////////////
 210     // Adapter for working with references
 211     /////////////////////////////////////////////////////////////////////////
 212
 213     /// Converts from `Option<T>` to `Option<&T>`.
 214     ///
 215     /// # Examples
 216     ///
 217     /// Convert an `Option<`[`String`]`>` into an `Option<`[`usize`]`>`, preserving the original.
 218     /// The [`map`] method takes the `self` argument by value, consuming the original,
 219     /// so this technique uses `as_ref` to first take an `Option` to a reference
 220     /// to the value inside the original.
 221     ///
 222     /// [`map`]: enum.Option.html#method.map
 223     /// [`String`]: ../../std/string/struct.String.html
 224     /// [`usize`]: ../../std/primitive.usize.html
 225     ///
 226     /// ```
 227     /// let text: Option<String> = Some("Hello, world!".to_string());
 228     /// // First, cast `Option<String>` to `Option<&String>` with `as_ref`,
 229     /// // then consume *that* with `map`, leaving `text` on the stack.
 230     /// let text_length: Option<usize> = text.as_ref().map(|s| s.len());
 231     /// println!("still can print text: {:?}", text);
 232     /// ```
 233     #[inline]
 234     #[stable(feature = "rust1", since = "1.0.0")]
 235     pub fn as_ref(&self) -> Option<&T> {
 236         match *self {
 237             Some(ref x) => Some(x),
 238             None => None,
 239         }
 240     }
 241
 242     /// Converts from `Option<T>` to `Option<&mut T>`.
 243     ///
 244     /// # Examples
 245     ///
 246     /// ```
 247     /// let mut x = Some(2);
 248     /// match x.as_mut() {
 249     ///     Some(v) => *v = 42,
 250     ///     None => {},
 251     /// }
 252     /// assert_eq!(x, Some(42));
 253     /// ```
 254     #[inline]
 255     #[stable(feature = "rust1", since = "1.0.0")]
 256     pub fn as_mut(&mut self) -> Option<&mut T> {
 257         match *self {
 258             Some(ref mut x) => Some(x),
 259             None => None,
 260         }
 261     }
 262
 263
 264     /// Converts from `Pin<&Option<T>>` to `Option<Pin<&T>>`
 265     #[inline]
 266     #[stable(feature = "pin", since = "1.33.0")]
 267     pub fn as_pin_ref<'a>(self: Pin<&'a Option<T>>) -> Option<Pin<&'a T>> {
 268         unsafe {
 269             Pin::get_ref(self).as_ref().map(|x| Pin::new_unchecked(x))
 270         }
 271     }
 272
 273     /// Converts from `Pin<&mut Option<T>>` to `Option<Pin<&mut T>>`
 274     #[inline]
 275     #[stable(feature = "pin", since = "1.33.0")]
 276     pub fn as_pin_mut<'a>(self: Pin<&'a mut Option<T>>) -> Option<Pin<&'a mut T>> {
 277         unsafe {
 278             Pin::get_unchecked_mut(self).as_mut().map(|x| Pin::new_unchecked(x))
 279         }
 280     }
 281
 282     /////////////////////////////////////////////////////////////////////////
 283     // Getting to contained values
 284     /////////////////////////////////////////////////////////////////////////
 285
 286     /// Unwraps an option, yielding the content of a [`Some`].
 287     ///
 288     /// # Panics
 289     ///
 290     /// Panics if the value is a [`None`] with a custom panic message provided by
 291     /// `msg`.
 292     ///
 293     /// [`Some`]: #variant.Some
 294     /// [`None`]: #variant.None
 295     ///
 296     /// # Examples
 297     ///
 298     /// ```
 299     /// let x = Some("value");
 300     /// assert_eq!(x.expect("the world is ending"), "value");
 301     /// ```
 302     ///
 303     /// ```{.should_panic}
 304     /// let x: Option<&str> = None;
 305     /// x.expect("the world is ending"); // panics with `the world is ending`
 306     /// ```
 307     #[inline]
 308     #[stable(feature = "rust1", since = "1.0.0")]
 309     pub fn expect(self, msg: &str) -> T {
 310         match self {
 311             Some(val) => val,
 312             None => expect_failed(msg),
 313         }
 314     }
 315
 316     /// Moves the value `v` out of the `Option<T>` if it is [`Some(v)`].
 317     ///
 318     /// In general, because this function may panic, its use is discouraged.
 319     /// Instead, prefer to use pattern matching and handle the [`None`]
 320     /// case explicitly.
 321     ///
 322     /// # Panics
 323     ///
 324     /// Panics if the self value equals [`None`].
 325     ///
 326     /// [`Some(v)`]: #variant.Some
 327     /// [`None`]: #variant.None
 328     ///
 329     /// # Examples
 330     ///
 331     /// ```
 332     /// let x = Some("air");
 333     /// assert_eq!(x.unwrap(), "air");
 334     /// ```
 335     ///
 336     /// ```{.should_panic}
 337     /// let x: Option<&str> = None;
 338     /// assert_eq!(x.unwrap(), "air"); // fails
 339     /// ```
 340     #[inline]
 341     #[stable(feature = "rust1", since = "1.0.0")]
 342     pub fn unwrap(self) -> T {
 343         match self {
 344             Some(val) => val,
 345             None => panic!("called `Option::unwrap()` on a `None` value"),
 346         }
 347     }
 348
 349     /// Returns the contained value or a default.
 350     ///
 351     /// Arguments passed to `unwrap_or` are eagerly evaluated; if you are passing
 352     /// the result of a function call, it is recommended to use [`unwrap_or_else`],
 353     /// which is lazily evaluated.
 354     ///
 355     /// [`unwrap_or_else`]: #method.unwrap_or_else
 356     ///
 357     /// # Examples
 358     ///
 359     /// ```
 360     /// assert_eq!(Some("car").unwrap_or("bike"), "car");
 361     /// assert_eq!(None.unwrap_or("bike"), "bike");
 362     /// ```
 363     #[inline]
 364     #[stable(feature = "rust1", since = "1.0.0")]
 365     pub fn unwrap_or(self, def: T) -> T {
 366         match self {
 367             Some(x) => x,
 368             None => def,
 369         }
 370     }
 371
 372     /// Returns the contained value or computes it from a closure.
 373     ///
 374     /// # Examples
 375     ///
 376     /// ```
 377     /// let k = 10;
 378     /// assert_eq!(Some(4).unwrap_or_else(|| 2 * k), 4);
 379     /// assert_eq!(None.unwrap_or_else(|| 2 * k), 20);
 380     /// ```
 381     #[inline]
 382     #[stable(feature = "rust1", since = "1.0.0")]
 383     pub fn unwrap_or_else<F: FnOnce() -> T>(self, f: F) -> T {
 384         match self {
 385             Some(x) => x,
 386             None => f(),
 387         }
 388     }
 389
 390     /////////////////////////////////////////////////////////////////////////
 391     // Transforming contained values
 392     /////////////////////////////////////////////////////////////////////////
 393
 394     /// Maps an `Option<T>` to `Option<U>` by applying a function to a contained value.
 395     ///
 396     /// # Examples
 397     ///
 398     /// Convert an `Option<`[`String`]`>` into an `Option<`[`usize`]`>`, consuming the original:
 399     ///
 400     /// [`String`]: ../../std/string/struct.String.html
 401     /// [`usize`]: ../../std/primitive.usize.html
 402     ///
 403     /// ```
 404     /// let maybe_some_string = Some(String::from("Hello, World!"));
 405     /// // `Option::map` takes self *by value*, consuming `maybe_some_string`
 406     /// let maybe_some_len = maybe_some_string.map(|s| s.len());
 407     ///
 408     /// assert_eq!(maybe_some_len, Some(13));
 409     /// ```
 410     #[inline]
 411     #[stable(feature = "rust1", since = "1.0.0")]
 412     pub fn map<U, F: FnOnce(T) -> U>(self, f: F) -> Option<U> {
 413         match self {
 414             Some(x) => Some(f(x)),
 415             None => None,
 416         }
 417     }
 418
 419     /// Applies a function to the contained value (if any),
 420     /// or returns the provided default (if not).
 421     ///
 422     /// # Examples
 423     ///
 424     /// ```
 425     /// let x = Some("foo");
 426     /// assert_eq!(x.map_or(42, |v| v.len()), 3);
 427     ///
 428     /// let x: Option<&str> = None;
 429     /// assert_eq!(x.map_or(42, |v| v.len()), 42);
 430     /// ```
 431     #[inline]
 432     #[stable(feature = "rust1", since = "1.0.0")]
 433     pub fn map_or<U, F: FnOnce(T) -> U>(self, default: U, f: F) -> U {
 434         match self {
 435             Some(t) => f(t),
 436             None => default,
 437         }
 438     }
 439
 440     /// Applies a function to the contained value (if any),
 441     /// or computes a default (if not).
 442     ///
 443     /// # Examples
 444     ///
 445     /// ```
 446     /// let k = 21;
 447     ///
 448     /// let x = Some("foo");
 449     /// assert_eq!(x.map_or_else(|| 2 * k, |v| v.len()), 3);
 450     ///
 451     /// let x: Option<&str> = None;
 452     /// assert_eq!(x.map_or_else(|| 2 * k, |v| v.len()), 42);
 453     /// ```
 454     #[inline]
 455     #[stable(feature = "rust1", since = "1.0.0")]
 456     pub fn map_or_else<U, D: FnOnce() -> U, F: FnOnce(T) -> U>(self, default: D, f: F) -> U {
 457         match self {
 458             Some(t) => f(t),
 459             None => default(),
 460         }
 461     }
 462
 463     /// Transforms the `Option<T>` into a [`Result<T, E>`], mapping [`Some(v)`] to
 464     /// [`Ok(v)`] and [`None`] to [`Err(err)`].
 465     ///
 466     /// Arguments passed to `ok_or` are eagerly evaluated; if you are passing the
 467     /// result of a function call, it is recommended to use [`ok_or_else`], which is
 468     /// lazily evaluated.
 469     ///
 470     /// [`Result<T, E>`]: ../../std/result/enum.Result.html
 471     /// [`Ok(v)`]: ../../std/result/enum.Result.html#variant.Ok
 472     /// [`Err(err)`]: ../../std/result/enum.Result.html#variant.Err
 473     /// [`None`]: #variant.None
 474     /// [`Some(v)`]: #variant.Some
 475     /// [`ok_or_else`]: #method.ok_or_else
 476     ///
 477     /// # Examples
 478     ///
 479     /// ```
 480     /// let x = Some("foo");
 481     /// assert_eq!(x.ok_or(0), Ok("foo"));
 482     ///
 483     /// let x: Option<&str> = None;
 484     /// assert_eq!(x.ok_or(0), Err(0));
 485     /// ```
 486     #[inline]
 487     #[stable(feature = "rust1", since = "1.0.0")]
 488     pub fn ok_or<E>(self, err: E) -> Result<T, E> {
 489         match self {
 490             Some(v) => Ok(v),
 491             None => Err(err),
 492         }
 493     }
 494
 495     /// Transforms the `Option<T>` into a [`Result<T, E>`], mapping [`Some(v)`] to
 496     /// [`Ok(v)`] and [`None`] to [`Err(err())`].
 497     ///
 498     /// [`Result<T, E>`]: ../../std/result/enum.Result.html
 499     /// [`Ok(v)`]: ../../std/result/enum.Result.html#variant.Ok
 500     /// [`Err(err())`]: ../../std/result/enum.Result.html#variant.Err
 501     /// [`None`]: #variant.None
 502     /// [`Some(v)`]: #variant.Some
 503     ///
 504     /// # Examples
 505     ///
 506     /// ```
 507     /// let x = Some("foo");
 508     /// assert_eq!(x.ok_or_else(|| 0), Ok("foo"));
 509     ///
 510     /// let x: Option<&str> = None;
 511     /// assert_eq!(x.ok_or_else(|| 0), Err(0));
 512     /// ```
 513     #[inline]
 514     #[stable(feature = "rust1", since = "1.0.0")]
 515     pub fn ok_or_else<E, F: FnOnce() -> E>(self, err: F) -> Result<T, E> {
 516         match self {
 517             Some(v) => Ok(v),
 518             None => Err(err()),
 519         }
 520     }
 521
 522     /////////////////////////////////////////////////////////////////////////
 523     // Iterator constructors
 524     /////////////////////////////////////////////////////////////////////////
 525
 526     /// Returns an iterator over the possibly contained value.
 527     ///
 528     /// # Examples
 529     ///
 530     /// ```
 531     /// let x = Some(4);
 532     /// assert_eq!(x.iter().next(), Some(&4));
 533     ///
 534     /// let x: Option<u32> = None;
 535     /// assert_eq!(x.iter().next(), None);
 536     /// ```
 537     #[inline]
 538     #[stable(feature = "rust1", since = "1.0.0")]
 539     pub fn iter(&self) -> Iter<T> {
 540         Iter { inner: Item { opt: self.as_ref() } }
 541     }
 542
 543     /// Returns a mutable iterator over the possibly contained value.
 544     ///
 545     /// # Examples
 546     ///
 547     /// ```
 548     /// let mut x = Some(4);
 549     /// match x.iter_mut().next() {
 550     ///     Some(v) => *v = 42,
 551     ///     None => {},
 552     /// }
 553     /// assert_eq!(x, Some(42));
 554     ///
 555     /// let mut x: Option<u32> = None;
 556     /// assert_eq!(x.iter_mut().next(), None);
 557     /// ```
 558     #[inline]
 559     #[stable(feature = "rust1", since = "1.0.0")]
 560     pub fn iter_mut(&mut self) -> IterMut<T> {
 561         IterMut { inner: Item { opt: self.as_mut() } }
 562     }
 563
 564     /////////////////////////////////////////////////////////////////////////
 565     // Boolean operations on the values, eager and lazy
 566     /////////////////////////////////////////////////////////////////////////
 567
 568     /// Returns [`None`] if the option is [`None`], otherwise returns `optb`.
 569     ///
 570     /// [`None`]: #variant.None
 571     ///
 572     /// # Examples
 573     ///
 574     /// ```
 575     /// let x = Some(2);
 576     /// let y: Option<&str> = None;
 577     /// assert_eq!(x.and(y), None);
 578     ///
 579     /// let x: Option<u32> = None;
 580     /// let y = Some("foo");
 581     /// assert_eq!(x.and(y), None);
 582     ///
 583     /// let x = Some(2);
 584     /// let y = Some("foo");
 585     /// assert_eq!(x.and(y), Some("foo"));
 586     ///
 587     /// let x: Option<u32> = None;
 588     /// let y: Option<&str> = None;
 589     /// assert_eq!(x.and(y), None);
 590     /// ```
 591     #[inline]
 592     #[stable(feature = "rust1", since = "1.0.0")]
 593     pub fn and<U>(self, optb: Option<U>) -> Option<U> {
 594         match self {
 595             Some(_) => optb,
 596             None => None,
 597         }
 598     }
 599
 600     /// Returns [`None`] if the option is [`None`], otherwise calls `f` with the
 601     /// wrapped value and returns the result.
 602     ///
 603     /// Some languages call this operation flatmap.
 604     ///
 605     /// [`None`]: #variant.None
 606     ///
 607     /// # Examples
 608     ///
 609     /// ```
 610     /// fn sq(x: u32) -> Option<u32> { Some(x * x) }
 611     /// fn nope(_: u32) -> Option<u32> { None }
 612     ///
 613     /// assert_eq!(Some(2).and_then(sq).and_then(sq), Some(16));
 614     /// assert_eq!(Some(2).and_then(sq).and_then(nope), None);
 615     /// assert_eq!(Some(2).and_then(nope).and_then(sq), None);
 616     /// assert_eq!(None.and_then(sq).and_then(sq), None);
 617     /// ```
 618     #[inline]
 619     #[stable(feature = "rust1", since = "1.0.0")]
 620     pub fn and_then<U, F: FnOnce(T) -> Option<U>>(self, f: F) -> Option<U> {
 621         match self {
 622             Some(x) => f(x),
 623             None => None,
 624         }
 625     }
 626
 627     /// Returns `None` if the option is `None`, otherwise calls `predicate`
 628     /// with the wrapped value and returns:
 629     ///
 630     /// - `Some(t)` if `predicate` returns `true` (where `t` is the wrapped
 631     ///   value), and
 632     /// - `None` if `predicate` returns `false`.
 633     ///
 634     /// This function works similar to `Iterator::filter()`. You can imagine
 635     /// the `Option<T>` being an iterator over one or zero elements. `filter()`
 636     /// lets you decide which elements to keep.
 637     ///
 638     /// # Examples
 639     ///
 640     /// ```rust
 641     /// fn is_even(n: &i32) -> bool {
 642     ///     n % 2 == 0
 643     /// }
 644     ///
 645     /// assert_eq!(None.filter(is_even), None);
 646     /// assert_eq!(Some(3).filter(is_even), None);
 647     /// assert_eq!(Some(4).filter(is_even), Some(4));
 648     /// ```
 649     #[inline]
 650     #[stable(feature = "option_filter", since = "1.27.0")]
 651     pub fn filter<P: FnOnce(&T) -> bool>(self, predicate: P) -> Self {
 652         if let Some(x) = self {
 653             if predicate(&x) {
 654                 return Some(x)
 655             }
 656         }
 657         None
 658     }
 659
 660     /// Returns the option if it contains a value, otherwise returns `optb`.
 661     ///
 662     /// Arguments passed to `or` are eagerly evaluated; if you are passing the
 663     /// result of a function call, it is recommended to use [`or_else`], which is
 664     /// lazily evaluated.
 665     ///
 666     /// [`or_else`]: #method.or_else
 667     ///
 668     /// # Examples
 669     ///
 670     /// ```
 671     /// let x = Some(2);
 672     /// let y = None;
 673     /// assert_eq!(x.or(y), Some(2));
 674     ///
 675     /// let x = None;
 676     /// let y = Some(100);
 677     /// assert_eq!(x.or(y), Some(100));
 678     ///
 679     /// let x = Some(2);
 680     /// let y = Some(100);
 681     /// assert_eq!(x.or(y), Some(2));
 682     ///
 683     /// let x: Option<u32> = None;
 684     /// let y = None;
 685     /// assert_eq!(x.or(y), None);
 686     /// ```
 687     #[inline]
 688     #[stable(feature = "rust1", since = "1.0.0")]
 689     pub fn or(self, optb: Option<T>) -> Option<T> {
 690         match self {
 691             Some(_) => self,
 692             None => optb,
 693         }
 694     }
 695
 696     /// Returns the option if it contains a value, otherwise calls `f` and
 697     /// returns the result.
 698     ///
 699     /// # Examples
 700     ///
 701     /// ```
 702     /// fn nobody() -> Option<&'static str> { None }
 703     /// fn vikings() -> Option<&'static str> { Some("vikings") }
 704     ///
 705     /// assert_eq!(Some("barbarians").or_else(vikings), Some("barbarians"));
 706     /// assert_eq!(None.or_else(vikings), Some("vikings"));
 707     /// assert_eq!(None.or_else(nobody), None);
 708     /// ```
 709     #[inline]
 710     #[stable(feature = "rust1", since = "1.0.0")]
 711     pub fn or_else<F: FnOnce() -> Option<T>>(self, f: F) -> Option<T> {
 712         match self {
 713             Some(_) => self,
 714             None => f(),
 715         }
 716     }
 717
 718     /// Returns [`Some`] if exactly one of `self`, `optb` is [`Some`], otherwise returns `None`.
 719     ///
 720     /// [`Some`]: #variant.Some
 721     /// [`None`]: #variant.None
 722     ///
 723     /// # Examples
 724     ///
 725     /// ```
 726     /// #![feature(option_xor)]
 727     ///
 728     /// let x = Some(2);
 729     /// let y: Option<u32> = None;
 730     /// assert_eq!(x.xor(y), Some(2));
 731     ///
 732     /// let x: Option<u32> = None;
 733     /// let y = Some(2);
 734     /// assert_eq!(x.xor(y), Some(2));
 735     ///
 736     /// let x = Some(2);
 737     /// let y = Some(2);
 738     /// assert_eq!(x.xor(y), None);
 739     ///
 740     /// let x: Option<u32> = None;
 741     /// let y: Option<u32> = None;
 742     /// assert_eq!(x.xor(y), None);
 743     /// ```
 744     #[inline]
 745     #[unstable(feature = "option_xor", issue = "50512")]
 746     pub fn xor(self, optb: Option<T>) -> Option<T> {
 747         match (self, optb) {
 748             (Some(a), None) => Some(a),
 749             (None, Some(b)) => Some(b),
 750             _ => None,
 751         }
 752     }
 753
 754     /////////////////////////////////////////////////////////////////////////
 755     // Entry-like operations to insert if None and return a reference
 756     /////////////////////////////////////////////////////////////////////////
 757
 758     /// Inserts `v` into the option if it is [`None`], then
 759     /// returns a mutable reference to the contained value.
 760     ///
 761     /// [`None`]: #variant.None
 762     ///
 763     /// # Examples
 764     ///
 765     /// ```
 766     /// let mut x = None;
 767     ///
 768     /// {
 769     ///     let y: &mut u32 = x.get_or_insert(5);
 770     ///     assert_eq!(y, &5);
 771     ///
 772     ///     *y = 7;
 773     /// }
 774     ///
 775     /// assert_eq!(x, Some(7));
 776     /// ```
 777     #[inline]
 778     #[stable(feature = "option_entry", since = "1.20.0")]
 779     pub fn get_or_insert(&mut self, v: T) -> &mut T {
 780         match *self {
 781             None => *self = Some(v),
 782             _ => (),
 783         }
 784
 785         match *self {
 786             Some(ref mut v) => v,
 787             None => unsafe { hint::unreachable_unchecked() },
 788         }
 789     }
 790
 791     /// Inserts a value computed from `f` into the option if it is [`None`], then
 792     /// returns a mutable reference to the contained value.
 793     ///
 794     /// [`None`]: #variant.None
 795     ///
 796     /// # Examples
 797     ///
 798     /// ```
 799     /// let mut x = None;
 800     ///
 801     /// {
 802     ///     let y: &mut u32 = x.get_or_insert_with(|| 5);
 803     ///     assert_eq!(y, &5);
 804     ///
 805     ///     *y = 7;
 806     /// }
 807     ///
 808     /// assert_eq!(x, Some(7));
 809     /// ```
 810     #[inline]
 811     #[stable(feature = "option_entry", since = "1.20.0")]
 812     pub fn get_or_insert_with<F: FnOnce() -> T>(&mut self, f: F) -> &mut T {
 813         match *self {
 814             None => *self = Some(f()),
 815             _ => (),
 816         }
 817
 818         match *self {
 819             Some(ref mut v) => v,
 820             None => unsafe { hint::unreachable_unchecked() },
 821         }
 822     }
 823
 824     /////////////////////////////////////////////////////////////////////////
 825     // Misc
 826     /////////////////////////////////////////////////////////////////////////
 827
 828     /// Takes the value out of the option, leaving a [`None`] in its place.
 829     ///
 830     /// [`None`]: #variant.None
 831     ///
 832     /// # Examples
 833     ///
 834     /// ```
 835     /// let mut x = Some(2);
 836     /// let y = x.take();
 837     /// assert_eq!(x, None);
 838     /// assert_eq!(y, Some(2));
 839     ///
 840     /// let mut x: Option<u32> = None;
 841     /// let y = x.take();
 842     /// assert_eq!(x, None);
 843     /// assert_eq!(y, None);
 844     /// ```
 845     #[inline]
 846     #[stable(feature = "rust1", since = "1.0.0")]
 847     pub fn take(&mut self) -> Option<T> {
 848         mem::replace(self, None)
 849     }
 850
 851     /// Replaces the actual value in the option by the value given in parameter,
 852     /// returning the old value if present,
 853     /// leaving a [`Some`] in its place without deinitializing either one.
 854     ///
 855     /// [`Some`]: #variant.Some
 856     ///
 857     /// # Examples
 858     ///
 859     /// ```
 860     /// let mut x = Some(2);
 861     /// let old = x.replace(5);
 862     /// assert_eq!(x, Some(5));
 863     /// assert_eq!(old, Some(2));
 864     ///
 865     /// let mut x = None;
 866     /// let old = x.replace(3);
 867     /// assert_eq!(x, Some(3));
 868     /// assert_eq!(old, None);
 869     /// ```
 870     #[inline]
 871     #[stable(feature = "option_replace", since = "1.31.0")]
 872     pub fn replace(&mut self, value: T) -> Option<T> {
 873         mem::replace(self, Some(value))
 874     }
 875 }
 876
 877 impl<'a, T: Copy> Option<&'a T> {
 878     /// Maps an `Option<&T>` to an `Option<T>` by copying the contents of the
 879     /// option.
 880     ///
 881     /// # Examples
 882     ///
 883     /// ```
 884     /// #![feature(copied)]
 885     ///
 886     /// let x = 12;
 887     /// let opt_x = Some(&x);
 888     /// assert_eq!(opt_x, Some(&12));
 889     /// let copied = opt_x.copied();
 890     /// assert_eq!(copied, Some(12));
 891     /// ```
 892     #[unstable(feature = "copied", issue = "57126")]
 893     pub fn copied(self) -> Option<T> {
 894         self.map(|&t| t)
 895     }
 896 }
 897
 898 impl<'a, T: Copy> Option<&'a mut T> {
 899     /// Maps an `Option<&mut T>` to an `Option<T>` by copying the contents of the
 900     /// option.
 901     ///
 902     /// # Examples
 903     ///
 904     /// ```
 905     /// #![feature(copied)]
 906     ///
 907     /// let mut x = 12;
 908     /// let opt_x = Some(&mut x);
 909     /// assert_eq!(opt_x, Some(&mut 12));
 910     /// let copied = opt_x.copied();
 911     /// assert_eq!(copied, Some(12));
 912     /// ```
 913     #[unstable(feature = "copied", issue = "57126")]
 914     pub fn copied(self) -> Option<T> {
 915         self.map(|&mut t| t)
 916     }
 917 }
 918
 919 impl<'a, T: Clone> Option<&'a T> {
 920     /// Maps an `Option<&T>` to an `Option<T>` by cloning the contents of the
 921     /// option.
 922     ///
 923     /// # Examples
 924     ///
 925     /// ```
 926     /// let x = 12;
 927     /// let opt_x = Some(&x);
 928     /// assert_eq!(opt_x, Some(&12));
 929     /// let cloned = opt_x.cloned();
 930     /// assert_eq!(cloned, Some(12));
 931     /// ```
 932     #[stable(feature = "rust1", since = "1.0.0")]
 933     pub fn cloned(self) -> Option<T> {
 934         self.map(|t| t.clone())
 935     }
 936 }
 937
 938 impl<'a, T: Clone> Option<&'a mut T> {
 939     /// Maps an `Option<&mut T>` to an `Option<T>` by cloning the contents of the
 940     /// option.
 941     ///
 942     /// # Examples
 943     ///
 944     /// ```
 945     /// let mut x = 12;
 946     /// let opt_x = Some(&mut x);
 947     /// assert_eq!(opt_x, Some(&mut 12));
 948     /// let cloned = opt_x.cloned();
 949     /// assert_eq!(cloned, Some(12));
 950     /// ```
 951     #[stable(since = "1.26.0", feature = "option_ref_mut_cloned")]
 952     pub fn cloned(self) -> Option<T> {
 953         self.map(|t| t.clone())
 954     }
 955 }
 956
 957 impl<T: Default> Option<T> {
 958     /// Returns the contained value or a default
 959     ///
 960     /// Consumes the `self` argument then, if [`Some`], returns the contained
 961     /// value, otherwise if [`None`], returns the [default value] for that
 962     /// type.
 963     ///
 964     /// # Examples
 965     ///
 966     /// Convert a string to an integer, turning poorly-formed strings
 967     /// into 0 (the default value for integers). [`parse`] converts
 968     /// a string to any other type that implements [`FromStr`], returning
 969     /// [`None`] on error.
 970     ///
 971     /// ```
 972     /// let good_year_from_input = "1909";
 973     /// let bad_year_from_input = "190blarg";
 974     /// let good_year = good_year_from_input.parse().ok().unwrap_or_default();
 975     /// let bad_year = bad_year_from_input.parse().ok().unwrap_or_default();
 976     ///
 977     /// assert_eq!(1909, good_year);
 978     /// assert_eq!(0, bad_year);
 979     /// ```
 980     ///
 981     /// [`Some`]: #variant.Some
 982     /// [`None`]: #variant.None
 983     /// [default value]: ../default/trait.Default.html#tymethod.default
 984     /// [`parse`]: ../../std/primitive.str.html#method.parse
 985     /// [`FromStr`]: ../../std/str/trait.FromStr.html
 986     #[inline]
 987     #[stable(feature = "rust1", since = "1.0.0")]
 988     pub fn unwrap_or_default(self) -> T {
 989         match self {
 990             Some(x) => x,
 991             None => Default::default(),
 992         }
 993     }
 994 }
 995
 996 #[unstable(feature = "inner_deref", reason = "newly added", issue = "50264")]
 997 impl<T: Deref> Option<T> {
 998     /// Converts from `&Option<T>` to `Option<&T::Target>`.
 999     ///
1000     /// Leaves the original Option in-place, creating a new one with a reference
1001     /// to the original one, additionally coercing the contents via `Deref`.
1002     pub fn deref(&self) -> Option<&T::Target> {
1003         self.as_ref().map(|t| t.deref())
1004     }
1005 }
1006
1007 impl<T, E> Option<Result<T, E>> {
1008     /// Transposes an `Option` of a `Result` into a `Result` of an `Option`.
1009     ///
1010     /// `None` will be mapped to `Ok(None)`.
1011     /// `Some(Ok(_))` and `Some(Err(_))` will be mapped to `Ok(Some(_))` and `Err(_)`.
1012     ///
1013     /// # Examples
1014     ///
1015     /// ```
1016     /// #![feature(transpose_result)]
1017     ///
1018     /// #[derive(Debug, Eq, PartialEq)]
1019     /// struct SomeErr;
1020     ///
1021     /// let x: Result<Option<i32>, SomeErr> = Ok(Some(5));
1022     /// let y: Option<Result<i32, SomeErr>> = Some(Ok(5));
1023     /// assert_eq!(x, y.transpose());
1024     /// ```
1025     #[inline]
1026     #[unstable(feature = "transpose_result", issue = "47338")]
1027     pub fn transpose(self) -> Result<Option<T>, E> {
1028         match self {
1029             Some(Ok(x)) => Ok(Some(x)),
1030             Some(Err(e)) => Err(e),
1031             None => Ok(None),
1032         }
1033     }
1034 }
1035
1036 // This is a separate function to reduce the code size of .expect() itself.
1037 #[inline(never)]
1038 #[cold]
1039 fn expect_failed(msg: &str) -> ! {
1040     panic!("{}", msg)
1041 }
1042
1043 /////////////////////////////////////////////////////////////////////////////
1044 // Trait implementations
1045 /////////////////////////////////////////////////////////////////////////////
1046
1047 #[stable(feature = "rust1", since = "1.0.0")]
1048 impl<T> Default for Option<T> {
1049     /// Returns [`None`][Option::None].
1050     #[inline]
1051     fn default() -> Option<T> { None }
1052 }
1053
1054 #[stable(feature = "rust1", since = "1.0.0")]
1055 impl<T> IntoIterator for Option<T> {
1056     type Item = T;
1057     type IntoIter = IntoIter<T>;
1058
1059     /// Returns a consuming iterator over the possibly contained value.
1060     ///
1061     /// # Examples
1062     ///
1063     /// ```
1064     /// let x = Some("string");
1065     /// let v: Vec<&str> = x.into_iter().collect();
1066     /// assert_eq!(v, ["string"]);
1067     ///
1068     /// let x = None;
1069     /// let v: Vec<&str> = x.into_iter().collect();
1070     /// assert!(v.is_empty());
1071     /// ```
1072     #[inline]
1073     fn into_iter(self) -> IntoIter<T> {
1074         IntoIter { inner: Item { opt: self } }
1075     }
1076 }
1077
1078 #[stable(since = "1.4.0", feature = "option_iter")]
1079 impl<'a, T> IntoIterator for &'a Option<T> {
1080     type Item = &'a T;
1081     type IntoIter = Iter<'a, T>;
1082
1083     fn into_iter(self) -> Iter<'a, T> {
1084         self.iter()
1085     }
1086 }
1087
1088 #[stable(since = "1.4.0", feature = "option_iter")]
1089 impl<'a, T> IntoIterator for &'a mut Option<T> {
1090     type Item = &'a mut T;
1091     type IntoIter = IterMut<'a, T>;
1092
1093     fn into_iter(self) -> IterMut<'a, T> {
1094         self.iter_mut()
1095     }
1096 }
1097
1098 #[stable(since = "1.12.0", feature = "option_from")]
1099 impl<T> From<T> for Option<T> {
1100     fn from(val: T) -> Option<T> {
1101         Some(val)
1102     }
1103 }
1104
1105 #[stable(feature = "option_ref_from_ref_option", since = "1.30.0")]
1106 impl<'a, T> From<&'a Option<T>> for Option<&'a T> {
1107     fn from(o: &'a Option<T>) -> Option<&'a T> {
1108         o.as_ref()
1109     }
1110 }
1111
1112 #[stable(feature = "option_ref_from_ref_option", since = "1.30.0")]
1113 impl<'a, T> From<&'a mut Option<T>> for Option<&'a mut T> {
1114     fn from(o: &'a mut Option<T>) -> Option<&'a mut T> {
1115         o.as_mut()
1116     }
1117 }
1118
1119 /////////////////////////////////////////////////////////////////////////////
1120 // The Option Iterators
1121 /////////////////////////////////////////////////////////////////////////////
1122
1123 #[derive(Clone, Debug)]
1124 struct Item<A> {
1125     opt: Option<A>
1126 }
1127
1128 impl<A> Iterator for Item<A> {
1129     type Item = A;
1130
1131     #[inline]
1132     fn next(&mut self) -> Option<A> {
1133         self.opt.take()
1134     }
1135
1136     #[inline]
1137     fn size_hint(&self) -> (usize, Option<usize>) {
1138         match self.opt {
1139             Some(_) => (1, Some(1)),
1140             None => (0, Some(0)),
1141         }
1142     }
1143 }
1144
1145 impl<A> DoubleEndedIterator for Item<A> {
1146     #[inline]
1147     fn next_back(&mut self) -> Option<A> {
1148         self.opt.take()
1149     }
1150 }
1151
1152 impl<A> ExactSizeIterator for Item<A> {}
1153 impl<A> FusedIterator for Item<A> {}
1154 unsafe impl<A> TrustedLen for Item<A> {}
1155
1156 /// An iterator over a reference to the [`Some`] variant of an [`Option`].
1157 ///
1158 /// The iterator yields one value if the [`Option`] is a [`Some`], otherwise none.
1159 ///
1160 /// This `struct` is created by the [`Option::iter`] function.
1161 ///
1162 /// [`Option`]: enum.Option.html
1163 /// [`Some`]: enum.Option.html#variant.Some
1164 /// [`Option::iter`]: enum.Option.html#method.iter
1165 #[stable(feature = "rust1", since = "1.0.0")]
1166 #[derive(Debug)]
1167 pub struct Iter<'a, A: 'a> { inner: Item<&'a A> }
1168
1169 #[stable(feature = "rust1", since = "1.0.0")]
1170 impl<'a, A> Iterator for Iter<'a, A> {
1171     type Item = &'a A;
1172
1173     #[inline]
1174     fn next(&mut self) -> Option<&'a A> { self.inner.next() }
1175     #[inline]
1176     fn size_hint(&self) -> (usize, Option<usize>) { self.inner.size_hint() }
1177 }
1178
1179 #[stable(feature = "rust1", since = "1.0.0")]
1180 impl<'a, A> DoubleEndedIterator for Iter<'a, A> {
1181     #[inline]
1182     fn next_back(&mut self) -> Option<&'a A> { self.inner.next_back() }
1183 }
1184
1185 #[stable(feature = "rust1", since = "1.0.0")]
1186 impl<A> ExactSizeIterator for Iter<'_, A> {}
1187
1188 #[stable(feature = "fused", since = "1.26.0")]
1189 impl<A> FusedIterator for Iter<'_, A> {}
1190
1191 #[unstable(feature = "trusted_len", issue = "37572")]
1192 unsafe impl<A> TrustedLen for Iter<'_, A> {}
1193
1194 #[stable(feature = "rust1", since = "1.0.0")]
1195 impl<A> Clone for Iter<'_, A> {
1196     #[inline]
1197     fn clone(&self) -> Self {
1198         Iter { inner: self.inner.clone() }
1199     }
1200 }
1201
1202 /// An iterator over a mutable reference to the [`Some`] variant of an [`Option`].
1203 ///
1204 /// The iterator yields one value if the [`Option`] is a [`Some`], otherwise none.
1205 ///
1206 /// This `struct` is created by the [`Option::iter_mut`] function.
1207 ///
1208 /// [`Option`]: enum.Option.html
1209 /// [`Some`]: enum.Option.html#variant.Some
1210 /// [`Option::iter_mut`]: enum.Option.html#method.iter_mut
1211 #[stable(feature = "rust1", since = "1.0.0")]
1212 #[derive(Debug)]
1213 pub struct IterMut<'a, A: 'a> { inner: Item<&'a mut A> }
1214
1215 #[stable(feature = "rust1", since = "1.0.0")]
1216 impl<'a, A> Iterator for IterMut<'a, A> {
1217     type Item = &'a mut A;
1218
1219     #[inline]
1220     fn next(&mut self) -> Option<&'a mut A> { self.inner.next() }
1221     #[inline]
1222     fn size_hint(&self) -> (usize, Option<usize>) { self.inner.size_hint() }
1223 }
1224
1225 #[stable(feature = "rust1", since = "1.0.0")]
1226 impl<'a, A> DoubleEndedIterator for IterMut<'a, A> {
1227     #[inline]
1228     fn next_back(&mut self) -> Option<&'a mut A> { self.inner.next_back() }
1229 }
1230
1231 #[stable(feature = "rust1", since = "1.0.0")]
1232 impl<A> ExactSizeIterator for IterMut<'_, A> {}
1233
1234 #[stable(feature = "fused", since = "1.26.0")]
1235 impl<A> FusedIterator for IterMut<'_, A> {}
1236 #[unstable(feature = "trusted_len", issue = "37572")]
1237 unsafe impl<A> TrustedLen for IterMut<'_, A> {}
1238
1239 /// An iterator over the value in [`Some`] variant of an [`Option`].
1240 ///
1241 /// The iterator yields one value if the [`Option`] is a [`Some`], otherwise none.
1242 ///
1243 /// This `struct` is created by the [`Option::into_iter`] function.
1244 ///
1245 /// [`Option`]: enum.Option.html
1246 /// [`Some`]: enum.Option.html#variant.Some
1247 /// [`Option::into_iter`]: enum.Option.html#method.into_iter
1248 #[derive(Clone, Debug)]
1249 #[stable(feature = "rust1", since = "1.0.0")]
1250 pub struct IntoIter<A> { inner: Item<A> }
1251
1252 #[stable(feature = "rust1", since = "1.0.0")]
1253 impl<A> Iterator for IntoIter<A> {
1254     type Item = A;
1255
1256     #[inline]
1257     fn next(&mut self) -> Option<A> { self.inner.next() }
1258     #[inline]
1259     fn size_hint(&self) -> (usize, Option<usize>) { self.inner.size_hint() }
1260 }
1261
1262 #[stable(feature = "rust1", since = "1.0.0")]
1263 impl<A> DoubleEndedIterator for IntoIter<A> {
1264     #[inline]
1265     fn next_back(&mut self) -> Option<A> { self.inner.next_back() }
1266 }
1267
1268 #[stable(feature = "rust1", since = "1.0.0")]
1269 impl<A> ExactSizeIterator for IntoIter<A> {}
1270
1271 #[stable(feature = "fused", since = "1.26.0")]
1272 impl<A> FusedIterator for IntoIter<A> {}
1273
1274 #[unstable(feature = "trusted_len", issue = "37572")]
1275 unsafe impl<A> TrustedLen for IntoIter<A> {}
1276
1277 /////////////////////////////////////////////////////////////////////////////
1278 // FromIterator
1279 /////////////////////////////////////////////////////////////////////////////
1280
1281 #[stable(feature = "rust1", since = "1.0.0")]
1282 impl<A, V: FromIterator<A>> FromIterator<Option<A>> for Option<V> {
1283     /// Takes each element in the [`Iterator`]: if it is [`None`][Option::None],
1284     /// no further elements are taken, and the [`None`][Option::None] is
1285     /// returned. Should no [`None`][Option::None] occur, a container with the
1286     /// values of each [`Option`] is returned.
1287     ///
1288     /// # Examples
1289     ///
1290     /// Here is an example which increments every integer in a vector.
1291     /// `We use the checked variant of `add` that returns `None` when the
1292     /// calculation would result in an overflow.
1293     ///
1294     /// ```
1295     /// let items = vec![0_u16, 1, 2];
1296     ///
1297     /// let res: Option<Vec<u16>> = items
1298     ///     .iter()
1299     ///     .map(|x| x.checked_add(1))
1300     ///     .collect();
1301     ///
1302     /// assert_eq!(res, Some(vec![1, 2, 3]));
1303     /// ```
1304     ///
1305     /// As you can see, this will return the expected, valid items.
1306     ///
1307     /// Here is another example that tries to subtract one from another list
1308     /// of integers, this time checking for underflow:
1309     ///
1310     /// ```
1311     /// let items = vec![2_u16, 1, 0];
1312     ///
1313     /// let res: Option<Vec<u16>> = items
1314     ///     .iter()
1315     ///     .map(|x| x.checked_sub(1))
1316     ///     .collect();
1317     ///
1318     /// assert_eq!(res, None);
1319     /// ```
1320     ///
1321     /// Since the last element is zero, it would underflow. Thus, the resulting
1322     /// value is `None`.
1323     ///
1324     /// [`Iterator`]: ../iter/trait.Iterator.html
1325     #[inline]
1326     fn from_iter<I: IntoIterator<Item=Option<A>>>(iter: I) -> Option<V> {
1327         // FIXME(#11084): This could be replaced with Iterator::scan when this
1328         // performance bug is closed.
1329
1330         struct Adapter<Iter> {
1331             iter: Iter,
1332             found_none: bool,
1333         }
1334
1335         impl<T, Iter: Iterator<Item=Option<T>>> Iterator for Adapter<Iter> {
1336             type Item = T;
1337
1338             #[inline]
1339             fn next(&mut self) -> Option<T> {
1340                 match self.iter.next() {
1341                     Some(Some(value)) => Some(value),
1342                     Some(None) => {
1343                         self.found_none = true;
1344                         None
1345                     }
1346                     None => None,
1347                 }
1348             }
1349
1350             #[inline]
1351             fn size_hint(&self) -> (usize, Option<usize>) {
1352                 if self.found_none {
1353                     (0, Some(0))
1354                 } else {
1355                     let (_, upper) = self.iter.size_hint();
1356                     (0, upper)
1357                 }
1358             }
1359         }
1360
1361         let mut adapter = Adapter { iter: iter.into_iter(), found_none: false };
1362         let v: V = FromIterator::from_iter(adapter.by_ref());
1363
1364         if adapter.found_none {
1365             None
1366         } else {
1367             Some(v)
1368         }
1369     }
1370 }
1371
1372 /// The error type that results from applying the try operator (`?`) to a `None` value. If you wish
1373 /// to allow `x?` (where `x` is an `Option<T>`) to be converted into your error type, you can
1374 /// implement `impl From<NoneError>` for `YourErrorType`. In that case, `x?` within a function that
1375 /// returns `Result<_, YourErrorType>` will translate a `None` value into an `Err` result.
1376 #[unstable(feature = "try_trait", issue = "42327")]
1377 #[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Debug, Hash)]
1378 pub struct NoneError;
1379
1380 #[unstable(feature = "try_trait", issue = "42327")]
1381 impl<T> ops::Try for Option<T> {
1382     type Ok = T;
1383     type Error = NoneError;
1384
1385     #[inline]
1386     fn into_result(self) -> Result<T, NoneError> {
1387         self.ok_or(NoneError)
1388     }
1389
1390     #[inline]
1391     fn from_ok(v: T) -> Self {
1392         Some(v)
1393     }
1394
1395     #[inline]
1396     fn from_error(_: NoneError) -> Self {
1397         None
1398     }
1399 }