src/libcore/option.rs

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