src/libcore/result.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 //! Error handling with the `Result` type
  12 //!
  13 //! `Result<T, E>` is the type used for returning and propagating
  14 //! errors. It is an enum with the variants, `Ok(T)`, representing
  15 //! success and containing a value, and `Err(E)`, representing error
  16 //! and containing an error value.
  17 //!
  18 //! ```
  19 //! enum Result<T, E> {
  20 //!    Ok(T),
  21 //!    Err(E)
  22 //! }
  23 //! ```
  24 //!
  25 //! Functions return `Result` whenever errors are expected and
  26 //! recoverable. In the `std` crate `Result` is most prominently used
  27 //! for [I/O](../../std/io/index.html).
  28 //!
  29 //! A simple function returning `Result` might be
  30 //! defined and used like so:
  31 //!
  32 //! ```
  33 //! #[derive(Debug)]
  34 //! enum Version { Version1, Version2 }
  35 //!
  36 //! fn parse_version(header: &[u8]) -> Result<Version, &'static str> {
  37 //!     match header.get(0) {
  38 //!         None => Err("invalid header length"),
  39 //!         Some(&1) => Ok(Version::Version1),
  40 //!         Some(&2) => Ok(Version::Version2),
  41 //!         Some(_) => Err("invalid version")
  42 //!     }
  43 //! }
  44 //!
  45 //! let version = parse_version(&[1, 2, 3, 4]);
  46 //! match version {
  47 //!     Ok(v) => println!("working with version: {:?}", v),
  48 //!     Err(e) => println!("error parsing header: {:?}", e),
  49 //! }
  50 //! ```
  51 //!
  52 //! Pattern matching on `Result`s is clear and straightforward for
  53 //! simple cases, but `Result` comes with some convenience methods
  54 //! that make working with it more succinct.
  55 //!
  56 //! ```
  57 //! let good_result: Result<i32, i32> = Ok(10);
  58 //! let bad_result: Result<i32, i32> = Err(10);
  59 //!
  60 //! // The `is_ok` and `is_err` methods do what they say.
  61 //! assert!(good_result.is_ok() && !good_result.is_err());
  62 //! assert!(bad_result.is_err() && !bad_result.is_ok());
  63 //!
  64 //! // `map` consumes the `Result` and produces another.
  65 //! let good_result: Result<i32, i32> = good_result.map(|i| i + 1);
  66 //! let bad_result: Result<i32, i32> = bad_result.map(|i| i - 1);
  67 //!
  68 //! // Use `and_then` to continue the computation.
  69 //! let good_result: Result<bool, i32> = good_result.and_then(|i| Ok(i == 11));
  70 //!
  71 //! // Use `or_else` to handle the error.
  72 //! let bad_result: Result<i32, i32> = bad_result.or_else(|i| Ok(i + 20));
  73 //!
  74 //! // Consume the result and return the contents with `unwrap`.
  75 //! let final_awesome_result = good_result.unwrap();
  76 //! ```
  77 //!
  78 //! # Results must be used
  79 //!
  80 //! A common problem with using return values to indicate errors is
  81 //! that it is easy to ignore the return value, thus failing to handle
  82 //! the error. Result is annotated with the #[must_use] attribute,
  83 //! which will cause the compiler to issue a warning when a Result
  84 //! value is ignored. This makes `Result` especially useful with
  85 //! functions that may encounter errors but don't otherwise return a
  86 //! useful value.
  87 //!
  88 //! Consider the `write_all` method defined for I/O types
  89 //! by the [`Write`](../../std/io/trait.Write.html) trait:
  90 //!
  91 //! ```
  92 //! use std::io;
  93 //!
  94 //! trait Write {
  95 //!     fn write_all(&mut self, bytes: &[u8]) -> Result<(), io::Error>;
  96 //! }
  97 //! ```
  98 //!
  99 //! *Note: The actual definition of `Write` uses `io::Result`, which
 100 //! is just a synonym for `Result<T, io::Error>`.*
 101 //!
 102 //! This method doesn't produce a value, but the write may
 103 //! fail. It's crucial to handle the error case, and *not* write
 104 //! something like this:
 105 //!
 106 //! ```no_run
 107 //! use std::fs::File;
 108 //! use std::io::prelude::*;
 109 //!
 110 //! let mut file = File::create("valuable_data.txt").unwrap();
 111 //! // If `write_all` errors, then we'll never know, because the return
 112 //! // value is ignored.
 113 //! file.write_all(b"important message");
 114 //! ```
 115 //!
 116 //! If you *do* write that in Rust, the compiler will give you a
 117 //! warning (by default, controlled by the `unused_must_use` lint).
 118 //!
 119 //! You might instead, if you don't want to handle the error, simply
 120 //! panic, by converting to an `Option` with `ok`, then asserting
 121 //! success with `expect`. This will panic if the write fails, proving
 122 //! a marginally useful message indicating why:
 123 //!
 124 //! ```{.no_run}
 125 //! use std::fs::File;
 126 //! use std::io::prelude::*;
 127 //!
 128 //! let mut file = File::create("valuable_data.txt").unwrap();
 129 //! file.write_all(b"important message").ok().expect("failed to write message");
 130 //! ```
 131 //!
 132 //! You might also simply assert success:
 133 //!
 134 //! ```{.no_run}
 135 //! # use std::fs::File;
 136 //! # use std::io::prelude::*;
 137 //! # let mut file = File::create("valuable_data.txt").unwrap();
 138 //! assert!(file.write_all(b"important message").is_ok());
 139 //! ```
 140 //!
 141 //! Or propagate the error up the call stack with `try!`:
 142 //!
 143 //! ```
 144 //! # use std::fs::File;
 145 //! # use std::io::prelude::*;
 146 //! # use std::io;
 147 //! fn write_message() -> io::Result<()> {
 148 //!     let mut file = try!(File::create("valuable_data.txt"));
 149 //!     try!(file.write_all(b"important message"));
 150 //!     Ok(())
 151 //! }
 152 //! ```
 153 //!
 154 //! # The `try!` macro
 155 //!
 156 //! When writing code that calls many functions that return the
 157 //! `Result` type, the error handling can be tedious.  The `try!`
 158 //! macro hides some of the boilerplate of propagating errors up the
 159 //! call stack.
 160 //!
 161 //! It replaces this:
 162 //!
 163 //! ```
 164 //! use std::fs::File;
 165 //! use std::io::prelude::*;
 166 //! use std::io;
 167 //!
 168 //! struct Info {
 169 //!     name: String,
 170 //!     age: i32,
 171 //!     rating: i32,
 172 //! }
 173 //!
 174 //! fn write_info(info: &Info) -> io::Result<()> {
 175 //!     let mut file = try!(File::create("my_best_friends.txt"));
 176 //!     // Early return on error
 177 //!     if let Err(e) = file.write_all(format!("name: {}\n", info.name).as_bytes()) {
 178 //!         return Err(e)
 179 //!     }
 180 //!     if let Err(e) = file.write_all(format!("age: {}\n", info.age).as_bytes()) {
 181 //!         return Err(e)
 182 //!     }
 183 //!     if let Err(e) = file.write_all(format!("rating: {}\n", info.rating).as_bytes()) {
 184 //!         return Err(e)
 185 //!     }
 186 //!     Ok(())
 187 //! }
 188 //! ```
 189 //!
 190 //! With this:
 191 //!
 192 //! ```
 193 //! use std::fs::File;
 194 //! use std::io::prelude::*;
 195 //! use std::io;
 196 //!
 197 //! struct Info {
 198 //!     name: String,
 199 //!     age: i32,
 200 //!     rating: i32,
 201 //! }
 202 //!
 203 //! fn write_info(info: &Info) -> io::Result<()> {
 204 //!     let mut file = try!(File::create("my_best_friends.txt"));
 205 //!     // Early return on error
 206 //!     try!(file.write_all(format!("name: {}\n", info.name).as_bytes()));
 207 //!     try!(file.write_all(format!("age: {}\n", info.age).as_bytes()));
 208 //!     try!(file.write_all(format!("rating: {}\n", info.rating).as_bytes()));
 209 //!     Ok(())
 210 //! }
 211 //! ```
 212 //!
 213 //! *It's much nicer!*
 214 //!
 215 //! Wrapping an expression in `try!` will result in the unwrapped
 216 //! success (`Ok`) value, unless the result is `Err`, in which case
 217 //! `Err` is returned early from the enclosing function. Its simple definition
 218 //! makes it clear:
 219 //!
 220 //! ```
 221 //! macro_rules! try {
 222 //!     ($e:expr) => (match $e { Ok(e) => e, Err(e) => return Err(e) })
 223 //! }
 224 //! ```
 225 //!
 226 //! `try!` is imported by the prelude and is available everywhere, but it can only
 227 //! be used in functions that return `Result` because of the early return of
 228 //! `Err` that it provides.
 229
 230 #![stable(feature = "rust1", since = "1.0.0")]
 231
 232 use self::Result::{Ok, Err};
 233
 234 use clone::Clone;
 235 use fmt;
 236 use iter::{Iterator, DoubleEndedIterator, FromIterator, ExactSizeIterator, IntoIterator};
 237 use ops::FnOnce;
 238 use option::Option::{self, None, Some};
 239 use slice;
 240
 241 /// `Result` is a type that represents either success (`Ok`) or failure (`Err`).
 242 ///
 243 /// See the [`std::result`](index.html) module documentation for details.
 244 #[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Debug, Hash)]
 245 #[must_use]
 246 #[stable(feature = "rust1", since = "1.0.0")]
 247 pub enum Result<T, E> {
 248     /// Contains the success value
 249     #[stable(feature = "rust1", since = "1.0.0")]
 250     Ok(T),
 251
 252     /// Contains the error value
 253     #[stable(feature = "rust1", since = "1.0.0")]
 254     Err(E)
 255 }
 256
 257 /////////////////////////////////////////////////////////////////////////////
 258 // Type implementation
 259 /////////////////////////////////////////////////////////////////////////////
 260
 261 #[stable(feature = "rust1", since = "1.0.0")]
 262 impl<T, E> Result<T, E> {
 263     /////////////////////////////////////////////////////////////////////////
 264     // Querying the contained values
 265     /////////////////////////////////////////////////////////////////////////
 266
 267     /// Returns true if the result is `Ok`
 268     ///
 269     /// # Examples
 270     ///
 271     /// ```
 272     /// let x: Result<i32, &str> = Ok(-3);
 273     /// assert_eq!(x.is_ok(), true);
 274     ///
 275     /// let x: Result<i32, &str> = Err("Some error message");
 276     /// assert_eq!(x.is_ok(), false);
 277     /// ```
 278     #[inline]
 279     #[stable(feature = "rust1", since = "1.0.0")]
 280     pub fn is_ok(&self) -> bool {
 281         match *self {
 282             Ok(_) => true,
 283             Err(_) => false
 284         }
 285     }
 286
 287     /// Returns true if the result is `Err`
 288     ///
 289     /// # Examples
 290     ///
 291     /// ```
 292     /// let x: Result<i32, &str> = Ok(-3);
 293     /// assert_eq!(x.is_err(), false);
 294     ///
 295     /// let x: Result<i32, &str> = Err("Some error message");
 296     /// assert_eq!(x.is_err(), true);
 297     /// ```
 298     #[inline]
 299     #[stable(feature = "rust1", since = "1.0.0")]
 300     pub fn is_err(&self) -> bool {
 301         !self.is_ok()
 302     }
 303
 304     /////////////////////////////////////////////////////////////////////////
 305     // Adapter for each variant
 306     /////////////////////////////////////////////////////////////////////////
 307
 308     /// Converts from `Result<T, E>` to `Option<T>`
 309     ///
 310     /// Converts `self` into an `Option<T>`, consuming `self`,
 311     /// and discarding the error, if any.
 312     ///
 313     /// # Examples
 314     ///
 315     /// ```
 316     /// let x: Result<u32, &str> = Ok(2);
 317     /// assert_eq!(x.ok(), Some(2));
 318     ///
 319     /// let x: Result<u32, &str> = Err("Nothing here");
 320     /// assert_eq!(x.ok(), None);
 321     /// ```
 322     #[inline]
 323     #[stable(feature = "rust1", since = "1.0.0")]
 324     pub fn ok(self) -> Option<T> {
 325         match self {
 326             Ok(x)  => Some(x),
 327             Err(_) => None,
 328         }
 329     }
 330
 331     /// Converts from `Result<T, E>` to `Option<E>`
 332     ///
 333     /// Converts `self` into an `Option<E>`, consuming `self`,
 334     /// and discarding the success value, if any.
 335     ///
 336     /// # Examples
 337     ///
 338     /// ```
 339     /// let x: Result<u32, &str> = Ok(2);
 340     /// assert_eq!(x.err(), None);
 341     ///
 342     /// let x: Result<u32, &str> = Err("Nothing here");
 343     /// assert_eq!(x.err(), Some("Nothing here"));
 344     /// ```
 345     #[inline]
 346     #[stable(feature = "rust1", since = "1.0.0")]
 347     pub fn err(self) -> Option<E> {
 348         match self {
 349             Ok(_)  => None,
 350             Err(x) => Some(x),
 351         }
 352     }
 353
 354     /////////////////////////////////////////////////////////////////////////
 355     // Adapter for working with references
 356     /////////////////////////////////////////////////////////////////////////
 357
 358     /// Converts from `Result<T, E>` to `Result<&T, &E>`
 359     ///
 360     /// Produces a new `Result`, containing a reference
 361     /// into the original, leaving the original in place.
 362     ///
 363     /// ```
 364     /// let x: Result<u32, &str> = Ok(2);
 365     /// assert_eq!(x.as_ref(), Ok(&2));
 366     ///
 367     /// let x: Result<u32, &str> = Err("Error");
 368     /// assert_eq!(x.as_ref(), Err(&"Error"));
 369     /// ```
 370     #[inline]
 371     #[stable(feature = "rust1", since = "1.0.0")]
 372     pub fn as_ref(&self) -> Result<&T, &E> {
 373         match *self {
 374             Ok(ref x) => Ok(x),
 375             Err(ref x) => Err(x),
 376         }
 377     }
 378
 379     /// Converts from `Result<T, E>` to `Result<&mut T, &mut E>`
 380     ///
 381     /// ```
 382     /// fn mutate(r: &mut Result<i32, i32>) {
 383     ///     match r.as_mut() {
 384     ///         Ok(&mut ref mut v) => *v = 42,
 385     ///         Err(&mut ref mut e) => *e = 0,
 386     ///     }
 387     /// }
 388     ///
 389     /// let mut x: Result<i32, i32> = Ok(2);
 390     /// mutate(&mut x);
 391     /// assert_eq!(x.unwrap(), 42);
 392     ///
 393     /// let mut x: Result<i32, i32> = Err(13);
 394     /// mutate(&mut x);
 395     /// assert_eq!(x.unwrap_err(), 0);
 396     /// ```
 397     #[inline]
 398     #[stable(feature = "rust1", since = "1.0.0")]
 399     pub fn as_mut(&mut self) -> Result<&mut T, &mut E> {
 400         match *self {
 401             Ok(ref mut x) => Ok(x),
 402             Err(ref mut x) => Err(x),
 403         }
 404     }
 405
 406     /// Converts from `Result<T, E>` to `&[T]` (without copying)
 407     #[inline]
 408     #[unstable(feature = "as_slice", since = "unsure of the utility here",
 409                issue = "27776")]
 410     pub fn as_slice(&self) -> &[T] {
 411         match *self {
 412             Ok(ref x) => slice::ref_slice(x),
 413             Err(_) => {
 414                 // work around lack of implicit coercion from fixed-size array to slice
 415                 let emp: &[_] = &[];
 416                 emp
 417             }
 418         }
 419     }
 420
 421     /// Converts from `Result<T, E>` to `&mut [T]` (without copying)
 422     ///
 423     /// ```
 424     /// #![feature(as_slice)]
 425     ///
 426     /// let mut x: Result<&str, u32> = Ok("Gold");
 427     /// {
 428     ///     let v = x.as_mut_slice();
 429     ///     assert!(v == ["Gold"]);
 430     ///     v[0] = "Silver";
 431     ///     assert!(v == ["Silver"]);
 432     /// }
 433     /// assert_eq!(x, Ok("Silver"));
 434     ///
 435     /// let mut x: Result<&str, u32> = Err(45);
 436     /// assert!(x.as_mut_slice().is_empty());
 437     /// ```
 438     #[inline]
 439     #[unstable(feature = "as_slice",
 440                reason = "waiting for mut conventions",
 441                issue = "27776")]
 442     pub fn as_mut_slice(&mut self) -> &mut [T] {
 443         match *self {
 444             Ok(ref mut x) => slice::mut_ref_slice(x),
 445             Err(_) => {
 446                 // work around lack of implicit coercion from fixed-size array to slice
 447                 let emp: &mut [_] = &mut [];
 448                 emp
 449             }
 450         }
 451     }
 452
 453     /////////////////////////////////////////////////////////////////////////
 454     // Transforming contained values
 455     /////////////////////////////////////////////////////////////////////////
 456
 457     /// Maps a `Result<T, E>` to `Result<U, E>` by applying a function to an
 458     /// contained `Ok` value, leaving an `Err` value untouched.
 459     ///
 460     /// This function can be used to compose the results of two functions.
 461     ///
 462     /// # Examples
 463     ///
 464     /// Print the numbers on each line of a string multiplied by two.
 465     ///
 466     /// ```
 467     /// let line = "1\n2\n3\n4\n";
 468     ///
 469     /// for num in line.lines() {
 470     ///     match num.parse::<i32>().map(|i| i * 2) {
 471     ///         Ok(n) => println!("{}", n),
 472     ///         Err(..) => {}
 473     ///     }
 474     /// }
 475     /// ```
 476     #[inline]
 477     #[stable(feature = "rust1", since = "1.0.0")]
 478     pub fn map<U, F: FnOnce(T) -> U>(self, op: F) -> Result<U,E> {
 479         match self {
 480             Ok(t) => Ok(op(t)),
 481             Err(e) => Err(e)
 482         }
 483     }
 484
 485     /// Maps a `Result<T, E>` to `Result<T, F>` by applying a function to an
 486     /// contained `Err` value, leaving an `Ok` value untouched.
 487     ///
 488     /// This function can be used to pass through a successful result while handling
 489     /// an error.
 490     ///
 491     /// # Examples
 492     ///
 493     /// ```
 494     /// fn stringify(x: u32) -> String { format!("error code: {}", x) }
 495     ///
 496     /// let x: Result<u32, u32> = Ok(2);
 497     /// assert_eq!(x.map_err(stringify), Ok(2));
 498     ///
 499     /// let x: Result<u32, u32> = Err(13);
 500     /// assert_eq!(x.map_err(stringify), Err("error code: 13".to_string()));
 501     /// ```
 502     #[inline]
 503     #[stable(feature = "rust1", since = "1.0.0")]
 504     pub fn map_err<F, O: FnOnce(E) -> F>(self, op: O) -> Result<T,F> {
 505         match self {
 506             Ok(t) => Ok(t),
 507             Err(e) => Err(op(e))
 508         }
 509     }
 510
 511     /////////////////////////////////////////////////////////////////////////
 512     // Iterator constructors
 513     /////////////////////////////////////////////////////////////////////////
 514
 515     /// Returns an iterator over the possibly contained value.
 516     ///
 517     /// # Examples
 518     ///
 519     /// ```
 520     /// let x: Result<u32, &str> = Ok(7);
 521     /// assert_eq!(x.iter().next(), Some(&7));
 522     ///
 523     /// let x: Result<u32, &str> = Err("nothing!");
 524     /// assert_eq!(x.iter().next(), None);
 525     /// ```
 526     #[inline]
 527     #[stable(feature = "rust1", since = "1.0.0")]
 528     pub fn iter(&self) -> Iter<T> {
 529         Iter { inner: self.as_ref().ok() }
 530     }
 531
 532     /// Returns a mutable iterator over the possibly contained value.
 533     ///
 534     /// # Examples
 535     ///
 536     /// ```
 537     /// let mut x: Result<u32, &str> = Ok(7);
 538     /// match x.iter_mut().next() {
 539     ///     Some(&mut ref mut x) => *x = 40,
 540     ///     None => {},
 541     /// }
 542     /// assert_eq!(x, Ok(40));
 543     ///
 544     /// let mut x: Result<u32, &str> = Err("nothing!");
 545     /// assert_eq!(x.iter_mut().next(), None);
 546     /// ```
 547     #[inline]
 548     #[stable(feature = "rust1", since = "1.0.0")]
 549     pub fn iter_mut(&mut self) -> IterMut<T> {
 550         IterMut { inner: self.as_mut().ok() }
 551     }
 552
 553     ////////////////////////////////////////////////////////////////////////
 554     // Boolean operations on the values, eager and lazy
 555     /////////////////////////////////////////////////////////////////////////
 556
 557     /// Returns `res` if the result is `Ok`, otherwise returns the `Err` value of `self`.
 558     ///
 559     /// # Examples
 560     ///
 561     /// ```
 562     /// let x: Result<u32, &str> = Ok(2);
 563     /// let y: Result<&str, &str> = Err("late error");
 564     /// assert_eq!(x.and(y), Err("late error"));
 565     ///
 566     /// let x: Result<u32, &str> = Err("early error");
 567     /// let y: Result<&str, &str> = Ok("foo");
 568     /// assert_eq!(x.and(y), Err("early error"));
 569     ///
 570     /// let x: Result<u32, &str> = Err("not a 2");
 571     /// let y: Result<&str, &str> = Err("late error");
 572     /// assert_eq!(x.and(y), Err("not a 2"));
 573     ///
 574     /// let x: Result<u32, &str> = Ok(2);
 575     /// let y: Result<&str, &str> = Ok("different result type");
 576     /// assert_eq!(x.and(y), Ok("different result type"));
 577     /// ```
 578     #[inline]
 579     #[stable(feature = "rust1", since = "1.0.0")]
 580     pub fn and<U>(self, res: Result<U, E>) -> Result<U, E> {
 581         match self {
 582             Ok(_) => res,
 583             Err(e) => Err(e),
 584         }
 585     }
 586
 587     /// Calls `op` if the result is `Ok`, otherwise returns the `Err` value of `self`.
 588     ///
 589     /// This function can be used for control flow based on result values.
 590     ///
 591     /// # Examples
 592     ///
 593     /// ```
 594     /// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
 595     /// fn err(x: u32) -> Result<u32, u32> { Err(x) }
 596     ///
 597     /// assert_eq!(Ok(2).and_then(sq).and_then(sq), Ok(16));
 598     /// assert_eq!(Ok(2).and_then(sq).and_then(err), Err(4));
 599     /// assert_eq!(Ok(2).and_then(err).and_then(sq), Err(2));
 600     /// assert_eq!(Err(3).and_then(sq).and_then(sq), Err(3));
 601     /// ```
 602     #[inline]
 603     #[stable(feature = "rust1", since = "1.0.0")]
 604     pub fn and_then<U, F: FnOnce(T) -> Result<U, E>>(self, op: F) -> Result<U, E> {
 605         match self {
 606             Ok(t) => op(t),
 607             Err(e) => Err(e),
 608         }
 609     }
 610
 611     /// Returns `res` if the result is `Err`, otherwise returns the `Ok` value of `self`.
 612     ///
 613     /// # Examples
 614     ///
 615     /// ```
 616     /// let x: Result<u32, &str> = Ok(2);
 617     /// let y: Result<u32, &str> = Err("late error");
 618     /// assert_eq!(x.or(y), Ok(2));
 619     ///
 620     /// let x: Result<u32, &str> = Err("early error");
 621     /// let y: Result<u32, &str> = Ok(2);
 622     /// assert_eq!(x.or(y), Ok(2));
 623     ///
 624     /// let x: Result<u32, &str> = Err("not a 2");
 625     /// let y: Result<u32, &str> = Err("late error");
 626     /// assert_eq!(x.or(y), Err("late error"));
 627     ///
 628     /// let x: Result<u32, &str> = Ok(2);
 629     /// let y: Result<u32, &str> = Ok(100);
 630     /// assert_eq!(x.or(y), Ok(2));
 631     /// ```
 632     #[inline]
 633     #[stable(feature = "rust1", since = "1.0.0")]
 634     pub fn or<F>(self, res: Result<T, F>) -> Result<T, F> {
 635         match self {
 636             Ok(v) => Ok(v),
 637             Err(_) => res,
 638         }
 639     }
 640
 641     /// Calls `op` if the result is `Err`, otherwise returns the `Ok` value of `self`.
 642     ///
 643     /// This function can be used for control flow based on result values.
 644     ///
 645     /// # Examples
 646     ///
 647     /// ```
 648     /// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
 649     /// fn err(x: u32) -> Result<u32, u32> { Err(x) }
 650     ///
 651     /// assert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));
 652     /// assert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));
 653     /// assert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));
 654     /// assert_eq!(Err(3).or_else(err).or_else(err), Err(3));
 655     /// ```
 656     #[inline]
 657     #[stable(feature = "rust1", since = "1.0.0")]
 658     pub fn or_else<F, O: FnOnce(E) -> Result<T, F>>(self, op: O) -> Result<T, F> {
 659         match self {
 660             Ok(t) => Ok(t),
 661             Err(e) => op(e),
 662         }
 663     }
 664
 665     /// Unwraps a result, yielding the content of an `Ok`.
 666     /// Else it returns `optb`.
 667     ///
 668     /// # Examples
 669     ///
 670     /// ```
 671     /// let optb = 2;
 672     /// let x: Result<u32, &str> = Ok(9);
 673     /// assert_eq!(x.unwrap_or(optb), 9);
 674     ///
 675     /// let x: Result<u32, &str> = Err("error");
 676     /// assert_eq!(x.unwrap_or(optb), optb);
 677     /// ```
 678     #[inline]
 679     #[stable(feature = "rust1", since = "1.0.0")]
 680     pub fn unwrap_or(self, optb: T) -> T {
 681         match self {
 682             Ok(t) => t,
 683             Err(_) => optb
 684         }
 685     }
 686
 687     /// Unwraps a result, yielding the content of an `Ok`.
 688     /// If the value is an `Err` then it calls `op` with its value.
 689     ///
 690     /// # Examples
 691     ///
 692     /// ```
 693     /// fn count(x: &str) -> usize { x.len() }
 694     ///
 695     /// assert_eq!(Ok(2).unwrap_or_else(count), 2);
 696     /// assert_eq!(Err("foo").unwrap_or_else(count), 3);
 697     /// ```
 698     #[inline]
 699     #[stable(feature = "rust1", since = "1.0.0")]
 700     pub fn unwrap_or_else<F: FnOnce(E) -> T>(self, op: F) -> T {
 701         match self {
 702             Ok(t) => t,
 703             Err(e) => op(e)
 704         }
 705     }
 706 }
 707
 708 #[stable(feature = "rust1", since = "1.0.0")]
 709 impl<T, E: fmt::Debug> Result<T, E> {
 710     /// Unwraps a result, yielding the content of an `Ok`.
 711     ///
 712     /// # Panics
 713     ///
 714     /// Panics if the value is an `Err`, with a panic message provided by the
 715     /// `Err`'s value.
 716     ///
 717     /// # Examples
 718     ///
 719     /// ```
 720     /// let x: Result<u32, &str> = Ok(2);
 721     /// assert_eq!(x.unwrap(), 2);
 722     /// ```
 723     ///
 724     /// ```{.should_panic}
 725     /// let x: Result<u32, &str> = Err("emergency failure");
 726     /// x.unwrap(); // panics with `emergency failure`
 727     /// ```
 728     #[inline]
 729     #[stable(feature = "rust1", since = "1.0.0")]
 730     pub fn unwrap(self) -> T {
 731         match self {
 732             Ok(t) => t,
 733             Err(e) =>
 734                 panic!("called `Result::unwrap()` on an `Err` value: {:?}", e)
 735         }
 736     }
 737
 738     /// Unwraps a result, yielding the content of an `Ok`.
 739     ///
 740     /// Panics if the value is an `Err`, with a panic message including the
 741     /// passed message, and the content of the `Err`.
 742     ///
 743     /// # Examples
 744     /// ```{.should_panic}
 745     /// #![feature(result_expect)]
 746     /// let x: Result<u32, &str> = Err("emergency failure");
 747     /// x.expect("Testing expect"); // panics with `Testing expect: emergency failure`
 748     /// ```
 749     #[inline]
 750     #[unstable(feature = "result_expect", reason = "newly introduced", issue = "27277")]
 751     pub fn expect(self, msg: &str) -> T {
 752         match self {
 753             Ok(t) => t,
 754             Err(e) => panic!("{}: {:?}", msg, e),
 755         }
 756     }
 757 }
 758
 759 #[stable(feature = "rust1", since = "1.0.0")]
 760 impl<T: fmt::Debug, E> Result<T, E> {
 761     /// Unwraps a result, yielding the content of an `Err`.
 762     ///
 763     /// # Panics
 764     ///
 765     /// Panics if the value is an `Ok`, with a custom panic message provided
 766     /// by the `Ok`'s value.
 767     ///
 768     /// # Examples
 769     ///
 770     /// ```{.should_panic}
 771     /// let x: Result<u32, &str> = Ok(2);
 772     /// x.unwrap_err(); // panics with `2`
 773     /// ```
 774     ///
 775     /// ```
 776     /// let x: Result<u32, &str> = Err("emergency failure");
 777     /// assert_eq!(x.unwrap_err(), "emergency failure");
 778     /// ```
 779     #[inline]
 780     #[stable(feature = "rust1", since = "1.0.0")]
 781     pub fn unwrap_err(self) -> E {
 782         match self {
 783             Ok(t) =>
 784                 panic!("called `Result::unwrap_err()` on an `Ok` value: {:?}", t),
 785             Err(e) => e
 786         }
 787     }
 788 }
 789
 790 /////////////////////////////////////////////////////////////////////////////
 791 // Trait implementations
 792 /////////////////////////////////////////////////////////////////////////////
 793
 794 #[stable(feature = "rust1", since = "1.0.0")]
 795 impl<T, E> IntoIterator for Result<T, E> {
 796     type Item = T;
 797     type IntoIter = IntoIter<T>;
 798
 799     /// Returns a consuming iterator over the possibly contained value.
 800     ///
 801     /// # Examples
 802     ///
 803     /// ```
 804     /// let x: Result<u32, &str> = Ok(5);
 805     /// let v: Vec<u32> = x.into_iter().collect();
 806     /// assert_eq!(v, [5]);
 807     ///
 808     /// let x: Result<u32, &str> = Err("nothing!");
 809     /// let v: Vec<u32> = x.into_iter().collect();
 810     /// assert_eq!(v, []);
 811     /// ```
 812     #[inline]
 813     fn into_iter(self) -> IntoIter<T> {
 814         IntoIter { inner: self.ok() }
 815     }
 816 }
 817
 818 /////////////////////////////////////////////////////////////////////////////
 819 // The Result Iterators
 820 /////////////////////////////////////////////////////////////////////////////
 821
 822 /// An iterator over a reference to the `Ok` variant of a `Result`.
 823 #[stable(feature = "rust1", since = "1.0.0")]
 824 pub struct Iter<'a, T: 'a> { inner: Option<&'a T> }
 825
 826 #[stable(feature = "rust1", since = "1.0.0")]
 827 impl<'a, T> Iterator for Iter<'a, T> {
 828     type Item = &'a T;
 829
 830     #[inline]
 831     fn next(&mut self) -> Option<&'a T> { self.inner.take() }
 832     #[inline]
 833     fn size_hint(&self) -> (usize, Option<usize>) {
 834         let n = if self.inner.is_some() {1} else {0};
 835         (n, Some(n))
 836     }
 837 }
 838
 839 #[stable(feature = "rust1", since = "1.0.0")]
 840 impl<'a, T> DoubleEndedIterator for Iter<'a, T> {
 841     #[inline]
 842     fn next_back(&mut self) -> Option<&'a T> { self.inner.take() }
 843 }
 844
 845 #[stable(feature = "rust1", since = "1.0.0")]
 846 impl<'a, T> ExactSizeIterator for Iter<'a, T> {}
 847
 848 impl<'a, T> Clone for Iter<'a, T> {
 849     fn clone(&self) -> Iter<'a, T> { Iter { inner: self.inner } }
 850 }
 851
 852 /// An iterator over a mutable reference to the `Ok` variant of a `Result`.
 853 #[stable(feature = "rust1", since = "1.0.0")]
 854 pub struct IterMut<'a, T: 'a> { inner: Option<&'a mut T> }
 855
 856 #[stable(feature = "rust1", since = "1.0.0")]
 857 impl<'a, T> Iterator for IterMut<'a, T> {
 858     type Item = &'a mut T;
 859
 860     #[inline]
 861     fn next(&mut self) -> Option<&'a mut T> { self.inner.take() }
 862     #[inline]
 863     fn size_hint(&self) -> (usize, Option<usize>) {
 864         let n = if self.inner.is_some() {1} else {0};
 865         (n, Some(n))
 866     }
 867 }
 868
 869 #[stable(feature = "rust1", since = "1.0.0")]
 870 impl<'a, T> DoubleEndedIterator for IterMut<'a, T> {
 871     #[inline]
 872     fn next_back(&mut self) -> Option<&'a mut T> { self.inner.take() }
 873 }
 874
 875 #[stable(feature = "rust1", since = "1.0.0")]
 876 impl<'a, T> ExactSizeIterator for IterMut<'a, T> {}
 877
 878 /// An iterator over the value in a `Ok` variant of a `Result`.
 879 #[stable(feature = "rust1", since = "1.0.0")]
 880 pub struct IntoIter<T> { inner: Option<T> }
 881
 882 #[stable(feature = "rust1", since = "1.0.0")]
 883 impl<T> Iterator for IntoIter<T> {
 884     type Item = T;
 885
 886     #[inline]
 887     fn next(&mut self) -> Option<T> { self.inner.take() }
 888     #[inline]
 889     fn size_hint(&self) -> (usize, Option<usize>) {
 890         let n = if self.inner.is_some() {1} else {0};
 891         (n, Some(n))
 892     }
 893 }
 894
 895 #[stable(feature = "rust1", since = "1.0.0")]
 896 impl<T> DoubleEndedIterator for IntoIter<T> {
 897     #[inline]
 898     fn next_back(&mut self) -> Option<T> { self.inner.take() }
 899 }
 900
 901 #[stable(feature = "rust1", since = "1.0.0")]
 902 impl<T> ExactSizeIterator for IntoIter<T> {}
 903
 904 /////////////////////////////////////////////////////////////////////////////
 905 // FromIterator
 906 /////////////////////////////////////////////////////////////////////////////
 907
 908 #[stable(feature = "rust1", since = "1.0.0")]
 909 impl<A, E, V: FromIterator<A>> FromIterator<Result<A, E>> for Result<V, E> {
 910     /// Takes each element in the `Iterator`: if it is an `Err`, no further
 911     /// elements are taken, and the `Err` is returned. Should no `Err` occur, a
 912     /// container with the values of each `Result` is returned.
 913     ///
 914     /// Here is an example which increments every integer in a vector,
 915     /// checking for overflow:
 916     ///
 917     /// ```
 918     /// use std::u32;
 919     ///
 920     /// let v = vec!(1, 2);
 921     /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|&x: &u32|
 922     ///     if x == u32::MAX { Err("Overflow!") }
 923     ///     else { Ok(x + 1) }
 924     /// ).collect();
 925     /// assert!(res == Ok(vec!(2, 3)));
 926     /// ```
 927     #[inline]
 928     fn from_iter<I: IntoIterator<Item=Result<A, E>>>(iter: I) -> Result<V, E> {
 929         // FIXME(#11084): This could be replaced with Iterator::scan when this
 930         // performance bug is closed.
 931
 932         struct Adapter<Iter, E> {
 933             iter: Iter,
 934             err: Option<E>,
 935         }
 936
 937         impl<T, E, Iter: Iterator<Item=Result<T, E>>> Iterator for Adapter<Iter, E> {
 938             type Item = T;
 939
 940             #[inline]
 941             fn next(&mut self) -> Option<T> {
 942                 match self.iter.next() {
 943                     Some(Ok(value)) => Some(value),
 944                     Some(Err(err)) => {
 945                         self.err = Some(err);
 946                         None
 947                     }
 948                     None => None,
 949                 }
 950             }
 951         }
 952
 953         let mut adapter = Adapter { iter: iter.into_iter(), err: None };
 954         let v: V = FromIterator::from_iter(adapter.by_ref());
 955
 956         match adapter.err {
 957             Some(err) => Err(err),
 958             None => Ok(v),
 959         }
 960     }
 961 }