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 {hint, mem, ops};
 150 use mem::PinMut;
 151
 152 // Note that this is not a lang item per se, but it has a hidden dependency on
 153 // `Iterator`, which is one. The compiler assumes that the `next` method of
 154 // `Iterator` is an enumeration with one type parameter and two variants,
 155 // which basically means it must be `Option`.
 156
 157 /// The `Option` type. See [the module level documentation](index.html) for more.
 158 #[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Debug, Hash)]
 159 #[stable(feature = "rust1", since = "1.0.0")]
 160 pub enum Option<T> {
 161     /// No value
 162     #[stable(feature = "rust1", since = "1.0.0")]
 163     None,
 164     /// Some value `T`
 165     #[stable(feature = "rust1", since = "1.0.0")]
 166     Some(#[stable(feature = "rust1", since = "1.0.0")] T),
 167 }
 168
 169 /////////////////////////////////////////////////////////////////////////////
 170 // Type implementation
 171 /////////////////////////////////////////////////////////////////////////////
 172
 173 impl<T> Option<T> {
 174     /////////////////////////////////////////////////////////////////////////
 175     // Querying the contained values
 176     /////////////////////////////////////////////////////////////////////////
 177
 178     /// Returns `true` if the option is a [`Some`] value.
 179     ///
 180     /// # Examples
 181     ///
 182     /// ```
 183     /// let x: Option<u32> = Some(2);
 184     /// assert_eq!(x.is_some(), true);
 185     ///
 186     /// let x: Option<u32> = None;
 187     /// assert_eq!(x.is_some(), false);
 188     /// ```
 189     ///
 190     /// [`Some`]: #variant.Some
 191     #[inline]
 192     #[stable(feature = "rust1", since = "1.0.0")]
 193     pub fn is_some(&self) -> bool {
 194         match *self {
 195             Some(_) => true,
 196             None => false,
 197         }
 198     }
 199
 200     /// Returns `true` if the option is a [`None`] value.
 201     ///
 202     /// # Examples
 203     ///
 204     /// ```
 205     /// let x: Option<u32> = Some(2);
 206     /// assert_eq!(x.is_none(), false);
 207     ///
 208     /// let x: Option<u32> = None;
 209     /// assert_eq!(x.is_none(), true);
 210     /// ```
 211     ///
 212     /// [`None`]: #variant.None
 213     #[inline]
 214     #[stable(feature = "rust1", since = "1.0.0")]
 215     pub fn is_none(&self) -> bool {
 216         !self.is_some()
 217     }
 218
 219     /////////////////////////////////////////////////////////////////////////
 220     // Adapter for working with references
 221     /////////////////////////////////////////////////////////////////////////
 222
 223     /// Converts from `Option<T>` to `Option<&T>`.
 224     ///
 225     /// # Examples
 226     ///
 227     /// Convert an `Option<`[`String`]`>` into an `Option<`[`usize`]`>`, preserving the original.
 228     /// The [`map`] method takes the `self` argument by value, consuming the original,
 229     /// so this technique uses `as_ref` to first take an `Option` to a reference
 230     /// to the value inside the original.
 231     ///
 232     /// [`map`]: enum.Option.html#method.map
 233     /// [`String`]: ../../std/string/struct.String.html
 234     /// [`usize`]: ../../std/primitive.usize.html
 235     ///
 236     /// ```
 237     /// let text: Option<String> = Some("Hello, world!".to_string());
 238     /// // First, cast `Option<String>` to `Option<&String>` with `as_ref`,
 239     /// // then consume *that* with `map`, leaving `text` on the stack.
 240     /// let text_length: Option<usize> = text.as_ref().map(|s| s.len());
 241     /// println!("still can print text: {:?}", text);
 242     /// ```
 243     #[inline]
 244     #[stable(feature = "rust1", since = "1.0.0")]
 245     pub fn as_ref(&self) -> Option<&T> {
 246         match *self {
 247             Some(ref x) => Some(x),
 248             None => None,
 249         }
 250     }
 251
 252     /// Converts from `Option<T>` to `Option<&mut T>`.
 253     ///
 254     /// # Examples
 255     ///
 256     /// ```
 257     /// let mut x = Some(2);
 258     /// match x.as_mut() {
 259     ///     Some(v) => *v = 42,
 260     ///     None => {},
 261     /// }
 262     /// assert_eq!(x, Some(42));
 263     /// ```
 264     #[inline]
 265     #[stable(feature = "rust1", since = "1.0.0")]
 266     pub fn as_mut(&mut self) -> Option<&mut T> {
 267         match *self {
 268             Some(ref mut x) => Some(x),
 269             None => None,
 270         }
 271     }
 272
 273     /// Converts from `Option<T>` to `Option<PinMut<'_, T>>`
 274     #[inline]
 275     #[unstable(feature = "pin", issue = "49150")]
 276     pub fn as_pin_mut<'a>(self: PinMut<'a, Self>) -> Option<PinMut<'a, T>> {
 277         unsafe {
 278             PinMut::get_mut_unchecked(self).as_mut().map(|x| PinMut::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     /// x.take();
 837     /// assert_eq!(x, None);
 838     ///
 839     /// let mut x: Option<u32> = None;
 840     /// x.take();
 841     /// assert_eq!(x, None);
 842     /// ```
 843     #[inline]
 844     #[stable(feature = "rust1", since = "1.0.0")]
 845     pub fn take(&mut self) -> Option<T> {
 846         mem::replace(self, None)
 847     }
 848 }
 849
 850 impl<'a, T: Clone> Option<&'a T> {
 851     /// Maps an `Option<&T>` to an `Option<T>` by cloning the contents of the
 852     /// option.
 853     ///
 854     /// # Examples
 855     ///
 856     /// ```
 857     /// let x = 12;
 858     /// let opt_x = Some(&x);
 859     /// assert_eq!(opt_x, Some(&12));
 860     /// let cloned = opt_x.cloned();
 861     /// assert_eq!(cloned, Some(12));
 862     /// ```
 863     #[stable(feature = "rust1", since = "1.0.0")]
 864     pub fn cloned(self) -> Option<T> {
 865         self.map(|t| t.clone())
 866     }
 867 }
 868
 869 impl<'a, T: Clone> Option<&'a mut T> {
 870     /// Maps an `Option<&mut T>` to an `Option<T>` by cloning the contents of the
 871     /// option.
 872     ///
 873     /// # Examples
 874     ///
 875     /// ```
 876     /// let mut x = 12;
 877     /// let opt_x = Some(&mut x);
 878     /// assert_eq!(opt_x, Some(&mut 12));
 879     /// let cloned = opt_x.cloned();
 880     /// assert_eq!(cloned, Some(12));
 881     /// ```
 882     #[stable(since = "1.26.0", feature = "option_ref_mut_cloned")]
 883     pub fn cloned(self) -> Option<T> {
 884         self.map(|t| t.clone())
 885     }
 886 }
 887
 888 impl<T: Default> Option<T> {
 889     /// Returns the contained value or a default
 890     ///
 891     /// Consumes the `self` argument then, if [`Some`], returns the contained
 892     /// value, otherwise if [`None`], returns the [default value] for that
 893     /// type.
 894     ///
 895     /// # Examples
 896     ///
 897     /// Convert a string to an integer, turning poorly-formed strings
 898     /// into 0 (the default value for integers). [`parse`] converts
 899     /// a string to any other type that implements [`FromStr`], returning
 900     /// [`None`] on error.
 901     ///
 902     /// ```
 903     /// let good_year_from_input = "1909";
 904     /// let bad_year_from_input = "190blarg";
 905     /// let good_year = good_year_from_input.parse().ok().unwrap_or_default();
 906     /// let bad_year = bad_year_from_input.parse().ok().unwrap_or_default();
 907     ///
 908     /// assert_eq!(1909, good_year);
 909     /// assert_eq!(0, bad_year);
 910     /// ```
 911     ///
 912     /// [`Some`]: #variant.Some
 913     /// [`None`]: #variant.None
 914     /// [default value]: ../default/trait.Default.html#tymethod.default
 915     /// [`parse`]: ../../std/primitive.str.html#method.parse
 916     /// [`FromStr`]: ../../std/str/trait.FromStr.html
 917     #[inline]
 918     #[stable(feature = "rust1", since = "1.0.0")]
 919     pub fn unwrap_or_default(self) -> T {
 920         match self {
 921             Some(x) => x,
 922             None => Default::default(),
 923         }
 924     }
 925 }
 926
 927 impl<T, E> Option<Result<T, E>> {
 928     /// Transposes an `Option` of a `Result` into a `Result` of an `Option`.
 929     ///
 930     /// `None` will be mapped to `Ok(None)`.
 931     /// `Some(Ok(_))` and `Some(Err(_))` will be mapped to `Ok(Some(_))` and `Err(_)`.
 932     ///
 933     /// # Examples
 934     ///
 935     /// ```
 936     /// #![feature(transpose_result)]
 937     ///
 938     /// #[derive(Debug, Eq, PartialEq)]
 939     /// struct SomeErr;
 940     ///
 941     /// let x: Result<Option<i32>, SomeErr> = Ok(Some(5));
 942     /// let y: Option<Result<i32, SomeErr>> = Some(Ok(5));
 943     /// assert_eq!(x, y.transpose());
 944     /// ```
 945     #[inline]
 946     #[unstable(feature = "transpose_result", issue = "47338")]
 947     pub fn transpose(self) -> Result<Option<T>, E> {
 948         match self {
 949             Some(Ok(x)) => Ok(Some(x)),
 950             Some(Err(e)) => Err(e),
 951             None => Ok(None),
 952         }
 953     }
 954 }
 955
 956 // This is a separate function to reduce the code size of .expect() itself.
 957 #[inline(never)]
 958 #[cold]
 959 fn expect_failed(msg: &str) -> ! {
 960     panic!("{}", msg)
 961 }
 962
 963
 964 /////////////////////////////////////////////////////////////////////////////
 965 // Trait implementations
 966 /////////////////////////////////////////////////////////////////////////////
 967
 968 #[stable(feature = "rust1", since = "1.0.0")]
 969 impl<T> Default for Option<T> {
 970     /// Returns [`None`].
 971     ///
 972     /// [`None`]: #variant.None
 973     #[inline]
 974     fn default() -> Option<T> { None }
 975 }
 976
 977 #[stable(feature = "rust1", since = "1.0.0")]
 978 impl<T> IntoIterator for Option<T> {
 979     type Item = T;
 980     type IntoIter = IntoIter<T>;
 981
 982     /// Returns a consuming iterator over the possibly contained value.
 983     ///
 984     /// # Examples
 985     ///
 986     /// ```
 987     /// let x = Some("string");
 988     /// let v: Vec<&str> = x.into_iter().collect();
 989     /// assert_eq!(v, ["string"]);
 990     ///
 991     /// let x = None;
 992     /// let v: Vec<&str> = x.into_iter().collect();
 993     /// assert!(v.is_empty());
 994     /// ```
 995     #[inline]
 996     fn into_iter(self) -> IntoIter<T> {
 997         IntoIter { inner: Item { opt: self } }
 998     }
 999 }
1000
1001 #[stable(since = "1.4.0", feature = "option_iter")]
1002 impl<'a, T> IntoIterator for &'a Option<T> {
1003     type Item = &'a T;
1004     type IntoIter = Iter<'a, T>;
1005
1006     fn into_iter(self) -> Iter<'a, T> {
1007         self.iter()
1008     }
1009 }
1010
1011 #[stable(since = "1.4.0", feature = "option_iter")]
1012 impl<'a, T> IntoIterator for &'a mut Option<T> {
1013     type Item = &'a mut T;
1014     type IntoIter = IterMut<'a, T>;
1015
1016     fn into_iter(self) -> IterMut<'a, T> {
1017         self.iter_mut()
1018     }
1019 }
1020
1021 #[stable(since = "1.12.0", feature = "option_from")]
1022 impl<T> From<T> for Option<T> {
1023     fn from(val: T) -> Option<T> {
1024         Some(val)
1025     }
1026 }
1027
1028 /////////////////////////////////////////////////////////////////////////////
1029 // The Option Iterators
1030 /////////////////////////////////////////////////////////////////////////////
1031
1032 #[derive(Clone, Debug)]
1033 struct Item<A> {
1034     opt: Option<A>
1035 }
1036
1037 impl<A> Iterator for Item<A> {
1038     type Item = A;
1039
1040     #[inline]
1041     fn next(&mut self) -> Option<A> {
1042         self.opt.take()
1043     }
1044
1045     #[inline]
1046     fn size_hint(&self) -> (usize, Option<usize>) {
1047         match self.opt {
1048             Some(_) => (1, Some(1)),
1049             None => (0, Some(0)),
1050         }
1051     }
1052 }
1053
1054 impl<A> DoubleEndedIterator for Item<A> {
1055     #[inline]
1056     fn next_back(&mut self) -> Option<A> {
1057         self.opt.take()
1058     }
1059 }
1060
1061 impl<A> ExactSizeIterator for Item<A> {}
1062 impl<A> FusedIterator for Item<A> {}
1063 unsafe impl<A> TrustedLen for Item<A> {}
1064
1065 /// An iterator over a reference to the [`Some`] variant of an [`Option`].
1066 ///
1067 /// The iterator yields one value if the [`Option`] is a [`Some`], otherwise none.
1068 ///
1069 /// This `struct` is created by the [`Option::iter`] function.
1070 ///
1071 /// [`Option`]: enum.Option.html
1072 /// [`Some`]: enum.Option.html#variant.Some
1073 /// [`Option::iter`]: enum.Option.html#method.iter
1074 #[stable(feature = "rust1", since = "1.0.0")]
1075 #[derive(Debug)]
1076 pub struct Iter<'a, A: 'a> { inner: Item<&'a A> }
1077
1078 #[stable(feature = "rust1", since = "1.0.0")]
1079 impl<'a, A> Iterator for Iter<'a, A> {
1080     type Item = &'a A;
1081
1082     #[inline]
1083     fn next(&mut self) -> Option<&'a A> { self.inner.next() }
1084     #[inline]
1085     fn size_hint(&self) -> (usize, Option<usize>) { self.inner.size_hint() }
1086 }
1087
1088 #[stable(feature = "rust1", since = "1.0.0")]
1089 impl<'a, A> DoubleEndedIterator for Iter<'a, A> {
1090     #[inline]
1091     fn next_back(&mut self) -> Option<&'a A> { self.inner.next_back() }
1092 }
1093
1094 #[stable(feature = "rust1", since = "1.0.0")]
1095 impl<'a, A> ExactSizeIterator for Iter<'a, A> {}
1096
1097 #[stable(feature = "fused", since = "1.26.0")]
1098 impl<'a, A> FusedIterator for Iter<'a, A> {}
1099
1100 #[unstable(feature = "trusted_len", issue = "37572")]
1101 unsafe impl<'a, A> TrustedLen for Iter<'a, A> {}
1102
1103 #[stable(feature = "rust1", since = "1.0.0")]
1104 impl<'a, A> Clone for Iter<'a, A> {
1105     fn clone(&self) -> Iter<'a, A> {
1106         Iter { inner: self.inner.clone() }
1107     }
1108 }
1109
1110 /// An iterator over a mutable reference to the [`Some`] variant of an [`Option`].
1111 ///
1112 /// The iterator yields one value if the [`Option`] is a [`Some`], otherwise none.
1113 ///
1114 /// This `struct` is created by the [`Option::iter_mut`] function.
1115 ///
1116 /// [`Option`]: enum.Option.html
1117 /// [`Some`]: enum.Option.html#variant.Some
1118 /// [`Option::iter_mut`]: enum.Option.html#method.iter_mut
1119 #[stable(feature = "rust1", since = "1.0.0")]
1120 #[derive(Debug)]
1121 pub struct IterMut<'a, A: 'a> { inner: Item<&'a mut A> }
1122
1123 #[stable(feature = "rust1", since = "1.0.0")]
1124 impl<'a, A> Iterator for IterMut<'a, A> {
1125     type Item = &'a mut A;
1126
1127     #[inline]
1128     fn next(&mut self) -> Option<&'a mut A> { self.inner.next() }
1129     #[inline]
1130     fn size_hint(&self) -> (usize, Option<usize>) { self.inner.size_hint() }
1131 }
1132
1133 #[stable(feature = "rust1", since = "1.0.0")]
1134 impl<'a, A> DoubleEndedIterator for IterMut<'a, A> {
1135     #[inline]
1136     fn next_back(&mut self) -> Option<&'a mut A> { self.inner.next_back() }
1137 }
1138
1139 #[stable(feature = "rust1", since = "1.0.0")]
1140 impl<'a, A> ExactSizeIterator for IterMut<'a, A> {}
1141
1142 #[stable(feature = "fused", since = "1.26.0")]
1143 impl<'a, A> FusedIterator for IterMut<'a, A> {}
1144 #[unstable(feature = "trusted_len", issue = "37572")]
1145 unsafe impl<'a, A> TrustedLen for IterMut<'a, A> {}
1146
1147 /// An iterator over the value in [`Some`] variant of an [`Option`].
1148 ///
1149 /// The iterator yields one value if the [`Option`] is a [`Some`], otherwise none.
1150 ///
1151 /// This `struct` is created by the [`Option::into_iter`] function.
1152 ///
1153 /// [`Option`]: enum.Option.html
1154 /// [`Some`]: enum.Option.html#variant.Some
1155 /// [`Option::into_iter`]: enum.Option.html#method.into_iter
1156 #[derive(Clone, Debug)]
1157 #[stable(feature = "rust1", since = "1.0.0")]
1158 pub struct IntoIter<A> { inner: Item<A> }
1159
1160 #[stable(feature = "rust1", since = "1.0.0")]
1161 impl<A> Iterator for IntoIter<A> {
1162     type Item = A;
1163
1164     #[inline]
1165     fn next(&mut self) -> Option<A> { self.inner.next() }
1166     #[inline]
1167     fn size_hint(&self) -> (usize, Option<usize>) { self.inner.size_hint() }
1168 }
1169
1170 #[stable(feature = "rust1", since = "1.0.0")]
1171 impl<A> DoubleEndedIterator for IntoIter<A> {
1172     #[inline]
1173     fn next_back(&mut self) -> Option<A> { self.inner.next_back() }
1174 }
1175
1176 #[stable(feature = "rust1", since = "1.0.0")]
1177 impl<A> ExactSizeIterator for IntoIter<A> {}
1178
1179 #[stable(feature = "fused", since = "1.26.0")]
1180 impl<A> FusedIterator for IntoIter<A> {}
1181
1182 #[unstable(feature = "trusted_len", issue = "37572")]
1183 unsafe impl<A> TrustedLen for IntoIter<A> {}
1184
1185 /////////////////////////////////////////////////////////////////////////////
1186 // FromIterator
1187 /////////////////////////////////////////////////////////////////////////////
1188
1189 #[stable(feature = "rust1", since = "1.0.0")]
1190 impl<A, V: FromIterator<A>> FromIterator<Option<A>> for Option<V> {
1191     /// Takes each element in the [`Iterator`]: if it is [`None`], no further
1192     /// elements are taken, and the [`None`] is returned. Should no [`None`] occur, a
1193     /// container with the values of each `Option` is returned.
1194     ///
1195     /// Here is an example which increments every integer in a vector,
1196     /// checking for overflow:
1197     ///
1198     /// ```
1199     /// use std::u16;
1200     ///
1201     /// let v = vec![1, 2];
1202     /// let res: Option<Vec<u16>> = v.iter().map(|&x: &u16|
1203     ///     if x == u16::MAX { None }
1204     ///     else { Some(x + 1) }
1205     /// ).collect();
1206     /// assert!(res == Some(vec![2, 3]));
1207     /// ```
1208     ///
1209     /// [`Iterator`]: ../iter/trait.Iterator.html
1210     /// [`None`]: enum.Option.html#variant.None
1211     #[inline]
1212     fn from_iter<I: IntoIterator<Item=Option<A>>>(iter: I) -> Option<V> {
1213         // FIXME(#11084): This could be replaced with Iterator::scan when this
1214         // performance bug is closed.
1215
1216         struct Adapter<Iter> {
1217             iter: Iter,
1218             found_none: bool,
1219         }
1220
1221         impl<T, Iter: Iterator<Item=Option<T>>> Iterator for Adapter<Iter> {
1222             type Item = T;
1223
1224             #[inline]
1225             fn next(&mut self) -> Option<T> {
1226                 match self.iter.next() {
1227                     Some(Some(value)) => Some(value),
1228                     Some(None) => {
1229                         self.found_none = true;
1230                         None
1231                     }
1232                     None => None,
1233                 }
1234             }
1235
1236             #[inline]
1237             fn size_hint(&self) -> (usize, Option<usize>) {
1238                 if self.found_none {
1239                     (0, Some(0))
1240                 } else {
1241                     let (_, upper) = self.iter.size_hint();
1242                     (0, upper)
1243                 }
1244             }
1245         }
1246
1247         let mut adapter = Adapter { iter: iter.into_iter(), found_none: false };
1248         let v: V = FromIterator::from_iter(adapter.by_ref());
1249
1250         if adapter.found_none {
1251             None
1252         } else {
1253             Some(v)
1254         }
1255     }
1256 }
1257
1258 /// The error type that results from applying the try operator (`?`) to a `None` value. If you wish
1259 /// to allow `x?` (where `x` is an `Option<T>`) to be converted into your error type, you can
1260 /// implement `impl From<NoneError>` for `YourErrorType`. In that case, `x?` within a function that
1261 /// returns `Result<_, YourErrorType>` will translate a `None` value into an `Err` result.
1262 #[unstable(feature = "try_trait", issue = "42327")]
1263 #[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Debug, Hash)]
1264 pub struct NoneError;
1265
1266 #[unstable(feature = "try_trait", issue = "42327")]
1267 impl<T> ops::Try for Option<T> {
1268     type Ok = T;
1269     type Error = NoneError;
1270
1271     fn into_result(self) -> Result<T, NoneError> {
1272         self.ok_or(NoneError)
1273     }
1274
1275     fn from_ok(v: T) -> Self {
1276         Some(v)
1277     }
1278
1279     fn from_error(_: NoneError) -> Self {
1280         None
1281     }
1282 }