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 //! Options 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(...)`) or
  66 //! not (`None`).
  67 //!
  68 //! ```
  69 //! let optional: Option<Box<i32>> = None;
  70 //! check_optional(&optional);
  71 //!
  72 //! let optional: Option<Box<i32>> = 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!("have value {}", p),
  78 //!         None => println!("have 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 //! match msg {
  97 //!     Some(ref m) => println!("{}", *m),
  98 //!     None => (),
  99 //! }
 100 //!
 101 //! // Remove the contained string, destroying the Option
 102 //! let unwrapped_msg = match msg {
 103 //!     Some(m) => m,
 104 //!     None => "default message",
 105 //! };
 106 //! ```
 107 //!
 108 //! Initialize a result to `None` before a loop:
 109 //!
 110 //! ```
 111 //! enum Kingdom { Plant(u32, &'static str), Animal(u32, &'static str) }
 112 //!
 113 //! // A list of data to search through.
 114 //! let all_the_big_things = [
 115 //!     Kingdom::Plant(250, "redwood"),
 116 //!     Kingdom::Plant(230, "noble fir"),
 117 //!     Kingdom::Plant(229, "sugar pine"),
 118 //!     Kingdom::Animal(25, "blue whale"),
 119 //!     Kingdom::Animal(19, "fin whale"),
 120 //!     Kingdom::Animal(15, "north pacific right whale"),
 121 //! ];
 122 //!
 123 //! // We're going to search for the name of the biggest animal,
 124 //! // but to start with we've just got `None`.
 125 //! let mut name_of_biggest_animal = None;
 126 //! let mut size_of_biggest_animal = 0;
 127 //! for big_thing in &all_the_big_things {
 128 //!     match *big_thing {
 129 //!         Kingdom::Animal(size, name) if size > size_of_biggest_animal => {
 130 //!             // Now we've found the name of some big animal
 131 //!             size_of_biggest_animal = size;
 132 //!             name_of_biggest_animal = Some(name);
 133 //!         }
 134 //!         Kingdom::Animal(..) | Kingdom::Plant(..) => ()
 135 //!     }
 136 //! }
 137 //!
 138 //! match name_of_biggest_animal {
 139 //!     Some(name) => println!("the biggest animal is {}", name),
 140 //!     None => println!("there are no animals :("),
 141 //! }
 142 //! ```
 143
 144 #![stable(feature = "rust1", since = "1.0.0")]
 145
 146 use self::Option::*;
 147
 148 use clone::Clone;
 149 use cmp::{Eq, Ord};
 150 use default::Default;
 151 use iter::ExactSizeIterator;
 152 use iter::{Iterator, DoubleEndedIterator, FromIterator, IntoIterator};
 153 use mem;
 154 use ops::FnOnce;
 155 use result::Result::{Ok, Err};
 156 use result::Result;
 157 use slice;
 158
 159 // Note that this is not a lang item per se, but it has a hidden dependency on
 160 // `Iterator`, which is one. The compiler assumes that the `next` method of
 161 // `Iterator` is an enumeration with one type parameter and two variants,
 162 // which basically means it must be `Option`.
 163
 164 /// The `Option` type. See [the module level documentation](index.html) for more.
 165 #[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Debug, Hash)]
 166 #[stable(feature = "rust1", since = "1.0.0")]
 167 pub enum Option<T> {
 168     /// No value
 169     #[stable(feature = "rust1", since = "1.0.0")]
 170     None,
 171     /// Some value `T`
 172     #[stable(feature = "rust1", since = "1.0.0")]
 173     Some(T)
 174 }
 175
 176 /////////////////////////////////////////////////////////////////////////////
 177 // Type implementation
 178 /////////////////////////////////////////////////////////////////////////////
 179
 180 impl<T> Option<T> {
 181     /////////////////////////////////////////////////////////////////////////
 182     // Querying the contained values
 183     /////////////////////////////////////////////////////////////////////////
 184
 185     /// Returns `true` if the option is a `Some` value
 186     ///
 187     /// # Examples
 188     ///
 189     /// ```
 190     /// let x: Option<u32> = Some(2);
 191     /// assert_eq!(x.is_some(), true);
 192     ///
 193     /// let x: Option<u32> = None;
 194     /// assert_eq!(x.is_some(), false);
 195     /// ```
 196     #[inline]
 197     #[stable(feature = "rust1", since = "1.0.0")]
 198     pub fn is_some(&self) -> bool {
 199         match *self {
 200             Some(_) => true,
 201             None => false,
 202         }
 203     }
 204
 205     /// Returns `true` if the option is a `None` value
 206     ///
 207     /// # Examples
 208     ///
 209     /// ```
 210     /// let x: Option<u32> = Some(2);
 211     /// assert_eq!(x.is_none(), false);
 212     ///
 213     /// let x: Option<u32> = None;
 214     /// assert_eq!(x.is_none(), true);
 215     /// ```
 216     #[inline]
 217     #[stable(feature = "rust1", since = "1.0.0")]
 218     pub fn is_none(&self) -> bool {
 219         !self.is_some()
 220     }
 221
 222     /////////////////////////////////////////////////////////////////////////
 223     // Adapter for working with references
 224     /////////////////////////////////////////////////////////////////////////
 225
 226     /// Converts from `Option<T>` to `Option<&T>`
 227     ///
 228     /// # Examples
 229     ///
 230     /// Convert an `Option<String>` into an `Option<usize>`, preserving the original.
 231     /// The `map` method takes the `self` argument by value, consuming the original,
 232     /// so this technique uses `as_ref` to first take an `Option` to a reference
 233     /// to the value inside the original.
 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     /// Converts from `Option<T>` to `&mut [T]` (without copying)
 273     ///
 274     /// # Examples
 275     ///
 276     /// ```
 277     /// #![feature(as_slice)]
 278     ///
 279     /// let mut x = Some("Diamonds");
 280     /// {
 281     ///     let v = x.as_mut_slice();
 282     ///     assert!(v == ["Diamonds"]);
 283     ///     v[0] = "Dirt";
 284     ///     assert!(v == ["Dirt"]);
 285     /// }
 286     /// assert_eq!(x, Some("Dirt"));
 287     /// ```
 288     #[inline]
 289     #[unstable(feature = "as_slice",
 290                reason = "waiting for mut conventions",
 291                issue = "27776")]
 292     #[deprecated(since = "1.4.0", reason = "niche API, unclear of usefulness")]
 293     pub fn as_mut_slice(&mut self) -> &mut [T] {
 294         match *self {
 295             Some(ref mut x) => {
 296                 let result: &mut [T] = slice::mut_ref_slice(x);
 297                 result
 298             }
 299             None => {
 300                 let result: &mut [T] = &mut [];
 301                 result
 302             }
 303         }
 304     }
 305
 306     /////////////////////////////////////////////////////////////////////////
 307     // Getting to contained values
 308     /////////////////////////////////////////////////////////////////////////
 309
 310     /// Unwraps an option, yielding the content of a `Some`
 311     ///
 312     /// # Panics
 313     ///
 314     /// Panics if the value is a `None` with a custom panic message provided by
 315     /// `msg`.
 316     ///
 317     /// # Examples
 318     ///
 319     /// ```
 320     /// let x = Some("value");
 321     /// assert_eq!(x.expect("the world is ending"), "value");
 322     /// ```
 323     ///
 324     /// ```{.should_panic}
 325     /// let x: Option<&str> = None;
 326     /// x.expect("the world is ending"); // panics with `the world is ending`
 327     /// ```
 328     #[inline]
 329     #[stable(feature = "rust1", since = "1.0.0")]
 330     pub fn expect(self, msg: &str) -> T {
 331         match self {
 332             Some(val) => val,
 333             None => panic!("{}", msg),
 334         }
 335     }
 336
 337     /// Moves the value `v` out of the `Option<T>` if it is `Some(v)`.
 338     ///
 339     /// # Panics
 340     ///
 341     /// Panics if the self value equals `None`.
 342     ///
 343     /// # Safety note
 344     ///
 345     /// In general, because this function may panic, its use is discouraged.
 346     /// Instead, prefer to use pattern matching and handle the `None`
 347     /// case explicitly.
 348     ///
 349     /// # Examples
 350     ///
 351     /// ```
 352     /// let x = Some("air");
 353     /// assert_eq!(x.unwrap(), "air");
 354     /// ```
 355     ///
 356     /// ```{.should_panic}
 357     /// let x: Option<&str> = None;
 358     /// assert_eq!(x.unwrap(), "air"); // fails
 359     /// ```
 360     #[inline]
 361     #[stable(feature = "rust1", since = "1.0.0")]
 362     pub fn unwrap(self) -> T {
 363         match self {
 364             Some(val) => val,
 365             None => panic!("called `Option::unwrap()` on a `None` value"),
 366         }
 367     }
 368
 369     /// Returns the contained value or a default.
 370     ///
 371     /// # Examples
 372     ///
 373     /// ```
 374     /// assert_eq!(Some("car").unwrap_or("bike"), "car");
 375     /// assert_eq!(None.unwrap_or("bike"), "bike");
 376     /// ```
 377     #[inline]
 378     #[stable(feature = "rust1", since = "1.0.0")]
 379     pub fn unwrap_or(self, def: T) -> T {
 380         match self {
 381             Some(x) => x,
 382             None => def,
 383         }
 384     }
 385
 386     /// Returns the contained value or computes it from a closure.
 387     ///
 388     /// # Examples
 389     ///
 390     /// ```
 391     /// let k = 10;
 392     /// assert_eq!(Some(4).unwrap_or_else(|| 2 * k), 4);
 393     /// assert_eq!(None.unwrap_or_else(|| 2 * k), 20);
 394     /// ```
 395     #[inline]
 396     #[stable(feature = "rust1", since = "1.0.0")]
 397     pub fn unwrap_or_else<F: FnOnce() -> T>(self, f: F) -> T {
 398         match self {
 399             Some(x) => x,
 400             None => f(),
 401         }
 402     }
 403
 404     /////////////////////////////////////////////////////////////////////////
 405     // Transforming contained values
 406     /////////////////////////////////////////////////////////////////////////
 407
 408     /// Maps an `Option<T>` to `Option<U>` by applying a function to a contained value
 409     ///
 410     /// # Examples
 411     ///
 412     /// Convert an `Option<String>` into an `Option<usize>`, consuming the original:
 413     ///
 414     /// ```
 415     /// let maybe_some_string = Some(String::from("Hello, World!"));
 416     /// // `Option::map` takes self *by value*, consuming `maybe_some_string`
 417     /// let maybe_some_len = maybe_some_string.map(|s| s.len());
 418     ///
 419     /// assert_eq!(maybe_some_len, Some(13));
 420     /// ```
 421     #[inline]
 422     #[stable(feature = "rust1", since = "1.0.0")]
 423     pub fn map<U, F: FnOnce(T) -> U>(self, f: F) -> Option<U> {
 424         match self {
 425             Some(x) => Some(f(x)),
 426             None => None,
 427         }
 428     }
 429
 430     /// Applies a function to the contained value (if any),
 431     /// or returns a `default` (if not).
 432     ///
 433     /// # Examples
 434     ///
 435     /// ```
 436     /// let x = Some("foo");
 437     /// assert_eq!(x.map_or(42, |v| v.len()), 3);
 438     ///
 439     /// let x: Option<&str> = None;
 440     /// assert_eq!(x.map_or(42, |v| v.len()), 42);
 441     /// ```
 442     #[inline]
 443     #[stable(feature = "rust1", since = "1.0.0")]
 444     pub fn map_or<U, F: FnOnce(T) -> U>(self, default: U, f: F) -> U {
 445         match self {
 446             Some(t) => f(t),
 447             None => default,
 448         }
 449     }
 450
 451     /// Applies a function to the contained value (if any),
 452     /// or computes a `default` (if not).
 453     ///
 454     /// # Examples
 455     ///
 456     /// ```
 457     /// let k = 21;
 458     ///
 459     /// let x = Some("foo");
 460     /// assert_eq!(x.map_or_else(|| 2 * k, |v| v.len()), 3);
 461     ///
 462     /// let x: Option<&str> = None;
 463     /// assert_eq!(x.map_or_else(|| 2 * k, |v| v.len()), 42);
 464     /// ```
 465     #[inline]
 466     #[stable(feature = "rust1", since = "1.0.0")]
 467     pub fn map_or_else<U, D: FnOnce() -> U, F: FnOnce(T) -> U>(self, default: D, f: F) -> U {
 468         match self {
 469             Some(t) => f(t),
 470             None => default(),
 471         }
 472     }
 473
 474     /// Transforms the `Option<T>` into a `Result<T, E>`, mapping `Some(v)` to
 475     /// `Ok(v)` and `None` to `Err(err)`.
 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     /// # 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     /// # Examples
 565     ///
 566     /// ```
 567     /// let x = Some(2);
 568     /// let y: Option<&str> = None;
 569     /// assert_eq!(x.and(y), None);
 570     ///
 571     /// let x: Option<u32> = None;
 572     /// let y = Some("foo");
 573     /// assert_eq!(x.and(y), None);
 574     ///
 575     /// let x = Some(2);
 576     /// let y = Some("foo");
 577     /// assert_eq!(x.and(y), Some("foo"));
 578     ///
 579     /// let x: Option<u32> = None;
 580     /// let y: Option<&str> = None;
 581     /// assert_eq!(x.and(y), None);
 582     /// ```
 583     #[inline]
 584     #[stable(feature = "rust1", since = "1.0.0")]
 585     pub fn and<U>(self, optb: Option<U>) -> Option<U> {
 586         match self {
 587             Some(_) => optb,
 588             None => None,
 589         }
 590     }
 591
 592     /// Returns `None` if the option is `None`, otherwise calls `f` with the
 593     /// wrapped value and returns the result.
 594     ///
 595     /// Some languages call this operation flatmap.
 596     ///
 597     /// # Examples
 598     ///
 599     /// ```
 600     /// fn sq(x: u32) -> Option<u32> { Some(x * x) }
 601     /// fn nope(_: u32) -> Option<u32> { None }
 602     ///
 603     /// assert_eq!(Some(2).and_then(sq).and_then(sq), Some(16));
 604     /// assert_eq!(Some(2).and_then(sq).and_then(nope), None);
 605     /// assert_eq!(Some(2).and_then(nope).and_then(sq), None);
 606     /// assert_eq!(None.and_then(sq).and_then(sq), None);
 607     /// ```
 608     #[inline]
 609     #[stable(feature = "rust1", since = "1.0.0")]
 610     pub fn and_then<U, F: FnOnce(T) -> Option<U>>(self, f: F) -> Option<U> {
 611         match self {
 612             Some(x) => f(x),
 613             None => None,
 614         }
 615     }
 616
 617     /// Returns the option if it contains a value, otherwise returns `optb`.
 618     ///
 619     /// # Examples
 620     ///
 621     /// ```
 622     /// let x = Some(2);
 623     /// let y = None;
 624     /// assert_eq!(x.or(y), Some(2));
 625     ///
 626     /// let x = None;
 627     /// let y = Some(100);
 628     /// assert_eq!(x.or(y), Some(100));
 629     ///
 630     /// let x = Some(2);
 631     /// let y = Some(100);
 632     /// assert_eq!(x.or(y), Some(2));
 633     ///
 634     /// let x: Option<u32> = None;
 635     /// let y = None;
 636     /// assert_eq!(x.or(y), None);
 637     /// ```
 638     #[inline]
 639     #[stable(feature = "rust1", since = "1.0.0")]
 640     pub fn or(self, optb: Option<T>) -> Option<T> {
 641         match self {
 642             Some(_) => self,
 643             None => optb,
 644         }
 645     }
 646
 647     /// Returns the option if it contains a value, otherwise calls `f` and
 648     /// returns the result.
 649     ///
 650     /// # Examples
 651     ///
 652     /// ```
 653     /// fn nobody() -> Option<&'static str> { None }
 654     /// fn vikings() -> Option<&'static str> { Some("vikings") }
 655     ///
 656     /// assert_eq!(Some("barbarians").or_else(vikings), Some("barbarians"));
 657     /// assert_eq!(None.or_else(vikings), Some("vikings"));
 658     /// assert_eq!(None.or_else(nobody), None);
 659     /// ```
 660     #[inline]
 661     #[stable(feature = "rust1", since = "1.0.0")]
 662     pub fn or_else<F: FnOnce() -> Option<T>>(self, f: F) -> Option<T> {
 663         match self {
 664             Some(_) => self,
 665             None => f(),
 666         }
 667     }
 668
 669     /////////////////////////////////////////////////////////////////////////
 670     // Misc
 671     /////////////////////////////////////////////////////////////////////////
 672
 673     /// Takes the value out of the option, leaving a `None` in its place.
 674     ///
 675     /// # Examples
 676     ///
 677     /// ```
 678     /// let mut x = Some(2);
 679     /// x.take();
 680     /// assert_eq!(x, None);
 681     ///
 682     /// let mut x: Option<u32> = None;
 683     /// x.take();
 684     /// assert_eq!(x, None);
 685     /// ```
 686     #[inline]
 687     #[stable(feature = "rust1", since = "1.0.0")]
 688     pub fn take(&mut self) -> Option<T> {
 689         mem::replace(self, None)
 690     }
 691
 692     /// Converts from `Option<T>` to `&[T]` (without copying)
 693     #[inline]
 694     #[unstable(feature = "as_slice", reason = "unsure of the utility here",
 695                issue = "27776")]
 696     #[deprecated(since = "1.4.0", reason = "niche API, unclear of usefulness")]
 697     pub fn as_slice(&self) -> &[T] {
 698         match *self {
 699             Some(ref x) => slice::ref_slice(x),
 700             None => {
 701                 let result: &[_] = &[];
 702                 result
 703             }
 704         }
 705     }
 706 }
 707
 708 impl<'a, T: Clone> Option<&'a T> {
 709     /// Maps an `Option<&T>` to an `Option<T>` by cloning the contents of the
 710     /// option.
 711     #[stable(feature = "rust1", since = "1.0.0")]
 712     pub fn cloned(self) -> Option<T> {
 713         self.map(|t| t.clone())
 714     }
 715 }
 716
 717 impl<T: Default> Option<T> {
 718     /// Returns the contained value or a default
 719     ///
 720     /// Consumes the `self` argument then, if `Some`, returns the contained
 721     /// value, otherwise if `None`, returns the default value for that
 722     /// type.
 723     ///
 724     /// # Examples
 725     ///
 726     /// Convert a string to an integer, turning poorly-formed strings
 727     /// into 0 (the default value for integers). `parse` converts
 728     /// a string to any other type that implements `FromStr`, returning
 729     /// `None` on error.
 730     ///
 731     /// ```
 732     /// let good_year_from_input = "1909";
 733     /// let bad_year_from_input = "190blarg";
 734     /// let good_year = good_year_from_input.parse().ok().unwrap_or_default();
 735     /// let bad_year = bad_year_from_input.parse().ok().unwrap_or_default();
 736     ///
 737     /// assert_eq!(1909, good_year);
 738     /// assert_eq!(0, bad_year);
 739     /// ```
 740     #[inline]
 741     #[stable(feature = "rust1", since = "1.0.0")]
 742     pub fn unwrap_or_default(self) -> T {
 743         match self {
 744             Some(x) => x,
 745             None => Default::default(),
 746         }
 747     }
 748 }
 749
 750 /////////////////////////////////////////////////////////////////////////////
 751 // Trait implementations
 752 /////////////////////////////////////////////////////////////////////////////
 753
 754 #[stable(feature = "rust1", since = "1.0.0")]
 755 impl<T> Default for Option<T> {
 756     #[inline]
 757     #[stable(feature = "rust1", since = "1.0.0")]
 758     fn default() -> Option<T> { None }
 759 }
 760
 761 #[stable(feature = "rust1", since = "1.0.0")]
 762 impl<T> IntoIterator for Option<T> {
 763     type Item = T;
 764     type IntoIter = IntoIter<T>;
 765
 766     /// Returns a consuming iterator over the possibly contained value.
 767     ///
 768     /// # Examples
 769     ///
 770     /// ```
 771     /// let x = Some("string");
 772     /// let v: Vec<&str> = x.into_iter().collect();
 773     /// assert_eq!(v, ["string"]);
 774     ///
 775     /// let x = None;
 776     /// let v: Vec<&str> = x.into_iter().collect();
 777     /// assert!(v.is_empty());
 778     /// ```
 779     #[inline]
 780     fn into_iter(self) -> IntoIter<T> {
 781         IntoIter { inner: Item { opt: self } }
 782     }
 783 }
 784
 785 #[stable(since = "1.4.0", feature = "option_iter")]
 786 impl<'a, T> IntoIterator for &'a Option<T> {
 787     type Item = &'a T;
 788     type IntoIter = Iter<'a, T>;
 789
 790     fn into_iter(self) -> Iter<'a, T> {
 791         self.iter()
 792     }
 793 }
 794
 795 #[stable(since = "1.4.0", feature = "option_iter")]
 796 impl<'a, T> IntoIterator for &'a mut Option<T> {
 797     type Item = &'a mut T;
 798     type IntoIter = IterMut<'a, T>;
 799
 800     fn into_iter(mut self) -> IterMut<'a, T> {
 801         self.iter_mut()
 802     }
 803 }
 804
 805 /////////////////////////////////////////////////////////////////////////////
 806 // The Option Iterators
 807 /////////////////////////////////////////////////////////////////////////////
 808
 809 #[derive(Clone)]
 810 struct Item<A> {
 811     opt: Option<A>
 812 }
 813
 814 impl<A> Iterator for Item<A> {
 815     type Item = A;
 816
 817     #[inline]
 818     fn next(&mut self) -> Option<A> {
 819         self.opt.take()
 820     }
 821
 822     #[inline]
 823     fn size_hint(&self) -> (usize, Option<usize>) {
 824         match self.opt {
 825             Some(_) => (1, Some(1)),
 826             None => (0, Some(0)),
 827         }
 828     }
 829 }
 830
 831 impl<A> DoubleEndedIterator for Item<A> {
 832     #[inline]
 833     fn next_back(&mut self) -> Option<A> {
 834         self.opt.take()
 835     }
 836 }
 837
 838 impl<A> ExactSizeIterator for Item<A> {}
 839
 840 /// An iterator over a reference of the contained item in an Option.
 841 #[stable(feature = "rust1", since = "1.0.0")]
 842 pub struct Iter<'a, A: 'a> { inner: Item<&'a A> }
 843
 844 #[stable(feature = "rust1", since = "1.0.0")]
 845 impl<'a, A> Iterator for Iter<'a, A> {
 846     type Item = &'a A;
 847
 848     #[inline]
 849     fn next(&mut self) -> Option<&'a A> { self.inner.next() }
 850     #[inline]
 851     fn size_hint(&self) -> (usize, Option<usize>) { self.inner.size_hint() }
 852 }
 853
 854 #[stable(feature = "rust1", since = "1.0.0")]
 855 impl<'a, A> DoubleEndedIterator for Iter<'a, A> {
 856     #[inline]
 857     fn next_back(&mut self) -> Option<&'a A> { self.inner.next_back() }
 858 }
 859
 860 #[stable(feature = "rust1", since = "1.0.0")]
 861 impl<'a, A> ExactSizeIterator for Iter<'a, A> {}
 862
 863 #[stable(feature = "rust1", since = "1.0.0")]
 864 impl<'a, A> Clone for Iter<'a, A> {
 865     fn clone(&self) -> Iter<'a, A> {
 866         Iter { inner: self.inner.clone() }
 867     }
 868 }
 869
 870 /// An iterator over a mutable reference of the contained item in an Option.
 871 #[stable(feature = "rust1", since = "1.0.0")]
 872 pub struct IterMut<'a, A: 'a> { inner: Item<&'a mut A> }
 873
 874 #[stable(feature = "rust1", since = "1.0.0")]
 875 impl<'a, A> Iterator for IterMut<'a, A> {
 876     type Item = &'a mut A;
 877
 878     #[inline]
 879     fn next(&mut self) -> Option<&'a mut A> { self.inner.next() }
 880     #[inline]
 881     fn size_hint(&self) -> (usize, Option<usize>) { self.inner.size_hint() }
 882 }
 883
 884 #[stable(feature = "rust1", since = "1.0.0")]
 885 impl<'a, A> DoubleEndedIterator for IterMut<'a, A> {
 886     #[inline]
 887     fn next_back(&mut self) -> Option<&'a mut A> { self.inner.next_back() }
 888 }
 889
 890 #[stable(feature = "rust1", since = "1.0.0")]
 891 impl<'a, A> ExactSizeIterator for IterMut<'a, A> {}
 892
 893 /// An iterator over the item contained inside an Option.
 894 #[derive(Clone)]
 895 #[stable(feature = "rust1", since = "1.0.0")]
 896 pub struct IntoIter<A> { inner: Item<A> }
 897
 898 #[stable(feature = "rust1", since = "1.0.0")]
 899 impl<A> Iterator for IntoIter<A> {
 900     type Item = A;
 901
 902     #[inline]
 903     fn next(&mut self) -> Option<A> { self.inner.next() }
 904     #[inline]
 905     fn size_hint(&self) -> (usize, Option<usize>) { self.inner.size_hint() }
 906 }
 907
 908 #[stable(feature = "rust1", since = "1.0.0")]
 909 impl<A> DoubleEndedIterator for IntoIter<A> {
 910     #[inline]
 911     fn next_back(&mut self) -> Option<A> { self.inner.next_back() }
 912 }
 913
 914 #[stable(feature = "rust1", since = "1.0.0")]
 915 impl<A> ExactSizeIterator for IntoIter<A> {}
 916
 917 /////////////////////////////////////////////////////////////////////////////
 918 // FromIterator
 919 /////////////////////////////////////////////////////////////////////////////
 920
 921 #[stable(feature = "rust1", since = "1.0.0")]
 922 impl<A, V: FromIterator<A>> FromIterator<Option<A>> for Option<V> {
 923     /// Takes each element in the `Iterator`: if it is `None`, no further
 924     /// elements are taken, and the `None` is returned. Should no `None` occur, a
 925     /// container with the values of each `Option` is returned.
 926     ///
 927     /// Here is an example which increments every integer in a vector,
 928     /// checking for overflow:
 929     ///
 930     /// ```
 931     /// use std::u16;
 932     ///
 933     /// let v = vec!(1, 2);
 934     /// let res: Option<Vec<u16>> = v.iter().map(|&x: &u16|
 935     ///     if x == u16::MAX { None }
 936     ///     else { Some(x + 1) }
 937     /// ).collect();
 938     /// assert!(res == Some(vec!(2, 3)));
 939     /// ```
 940     #[inline]
 941     #[stable(feature = "rust1", since = "1.0.0")]
 942     fn from_iter<I: IntoIterator<Item=Option<A>>>(iter: I) -> Option<V> {
 943         // FIXME(#11084): This could be replaced with Iterator::scan when this
 944         // performance bug is closed.
 945
 946         struct Adapter<Iter> {
 947             iter: Iter,
 948             found_none: bool,
 949         }
 950
 951         impl<T, Iter: Iterator<Item=Option<T>>> Iterator for Adapter<Iter> {
 952             type Item = T;
 953
 954             #[inline]
 955             fn next(&mut self) -> Option<T> {
 956                 match self.iter.next() {
 957                     Some(Some(value)) => Some(value),
 958                     Some(None) => {
 959                         self.found_none = true;
 960                         None
 961                     }
 962                     None => None,
 963                 }
 964             }
 965         }
 966
 967         let mut adapter = Adapter { iter: iter.into_iter(), found_none: false };
 968         let v: V = FromIterator::from_iter(adapter.by_ref());
 969
 970         if adapter.found_none {
 971             None
 972         } else {
 973             Some(v)
 974         }
 975     }
 976 }