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", reason = "unsure of the utility here",
 409                issue = "27776")]
 410     #[deprecated(since = "1.4.0", reason = "niche API, unclear of usefulness")]
 411     #[allow(deprecated)]
 412     pub fn as_slice(&self) -> &[T] {
 413         match *self {
 414             Ok(ref x) => slice::ref_slice(x),
 415             Err(_) => {
 416                 // work around lack of implicit coercion from fixed-size array to slice
 417                 let emp: &[_] = &[];
 418                 emp
 419             }
 420         }
 421     }
 422
 423     /// Converts from `Result<T, E>` to `&mut [T]` (without copying)
 424     ///
 425     /// ```
 426     /// #![feature(as_slice)]
 427     ///
 428     /// let mut x: Result<&str, u32> = Ok("Gold");
 429     /// {
 430     ///     let v = x.as_mut_slice();
 431     ///     assert!(v == ["Gold"]);
 432     ///     v[0] = "Silver";
 433     ///     assert!(v == ["Silver"]);
 434     /// }
 435     /// assert_eq!(x, Ok("Silver"));
 436     ///
 437     /// let mut x: Result<&str, u32> = Err(45);
 438     /// assert!(x.as_mut_slice().is_empty());
 439     /// ```
 440     #[inline]
 441     #[unstable(feature = "as_slice",
 442                reason = "waiting for mut conventions",
 443                issue = "27776")]
 444     #[deprecated(since = "1.4.0", reason = "niche API, unclear of usefulness")]
 445     #[allow(deprecated)]
 446     pub fn as_mut_slice(&mut self) -> &mut [T] {
 447         match *self {
 448             Ok(ref mut x) => slice::mut_ref_slice(x),
 449             Err(_) => {
 450                 // work around lack of implicit coercion from fixed-size array to slice
 451                 let emp: &mut [_] = &mut [];
 452                 emp
 453             }
 454         }
 455     }
 456
 457     /////////////////////////////////////////////////////////////////////////
 458     // Transforming contained values
 459     /////////////////////////////////////////////////////////////////////////
 460
 461     /// Maps a `Result<T, E>` to `Result<U, E>` by applying a function to an
 462     /// contained `Ok` value, leaving an `Err` value untouched.
 463     ///
 464     /// This function can be used to compose the results of two functions.
 465     ///
 466     /// # Examples
 467     ///
 468     /// Print the numbers on each line of a string multiplied by two.
 469     ///
 470     /// ```
 471     /// let line = "1\n2\n3\n4\n";
 472     ///
 473     /// for num in line.lines() {
 474     ///     match num.parse::<i32>().map(|i| i * 2) {
 475     ///         Ok(n) => println!("{}", n),
 476     ///         Err(..) => {}
 477     ///     }
 478     /// }
 479     /// ```
 480     #[inline]
 481     #[stable(feature = "rust1", since = "1.0.0")]
 482     pub fn map<U, F: FnOnce(T) -> U>(self, op: F) -> Result<U,E> {
 483         match self {
 484             Ok(t) => Ok(op(t)),
 485             Err(e) => Err(e)
 486         }
 487     }
 488
 489     /// Maps a `Result<T, E>` to `Result<T, F>` by applying a function to an
 490     /// contained `Err` value, leaving an `Ok` value untouched.
 491     ///
 492     /// This function can be used to pass through a successful result while handling
 493     /// an error.
 494     ///
 495     /// # Examples
 496     ///
 497     /// ```
 498     /// fn stringify(x: u32) -> String { format!("error code: {}", x) }
 499     ///
 500     /// let x: Result<u32, u32> = Ok(2);
 501     /// assert_eq!(x.map_err(stringify), Ok(2));
 502     ///
 503     /// let x: Result<u32, u32> = Err(13);
 504     /// assert_eq!(x.map_err(stringify), Err("error code: 13".to_string()));
 505     /// ```
 506     #[inline]
 507     #[stable(feature = "rust1", since = "1.0.0")]
 508     pub fn map_err<F, O: FnOnce(E) -> F>(self, op: O) -> Result<T,F> {
 509         match self {
 510             Ok(t) => Ok(t),
 511             Err(e) => Err(op(e))
 512         }
 513     }
 514
 515     /////////////////////////////////////////////////////////////////////////
 516     // Iterator constructors
 517     /////////////////////////////////////////////////////////////////////////
 518
 519     /// Returns an iterator over the possibly contained value.
 520     ///
 521     /// # Examples
 522     ///
 523     /// ```
 524     /// let x: Result<u32, &str> = Ok(7);
 525     /// assert_eq!(x.iter().next(), Some(&7));
 526     ///
 527     /// let x: Result<u32, &str> = Err("nothing!");
 528     /// assert_eq!(x.iter().next(), None);
 529     /// ```
 530     #[inline]
 531     #[stable(feature = "rust1", since = "1.0.0")]
 532     pub fn iter(&self) -> Iter<T> {
 533         Iter { inner: self.as_ref().ok() }
 534     }
 535
 536     /// Returns a mutable iterator over the possibly contained value.
 537     ///
 538     /// # Examples
 539     ///
 540     /// ```
 541     /// let mut x: Result<u32, &str> = Ok(7);
 542     /// match x.iter_mut().next() {
 543     ///     Some(v) => *v = 40,
 544     ///     None => {},
 545     /// }
 546     /// assert_eq!(x, Ok(40));
 547     ///
 548     /// let mut x: Result<u32, &str> = Err("nothing!");
 549     /// assert_eq!(x.iter_mut().next(), None);
 550     /// ```
 551     #[inline]
 552     #[stable(feature = "rust1", since = "1.0.0")]
 553     pub fn iter_mut(&mut self) -> IterMut<T> {
 554         IterMut { inner: self.as_mut().ok() }
 555     }
 556
 557     ////////////////////////////////////////////////////////////////////////
 558     // Boolean operations on the values, eager and lazy
 559     /////////////////////////////////////////////////////////////////////////
 560
 561     /// Returns `res` if the result is `Ok`, otherwise returns the `Err` value of `self`.
 562     ///
 563     /// # Examples
 564     ///
 565     /// ```
 566     /// let x: Result<u32, &str> = Ok(2);
 567     /// let y: Result<&str, &str> = Err("late error");
 568     /// assert_eq!(x.and(y), Err("late error"));
 569     ///
 570     /// let x: Result<u32, &str> = Err("early error");
 571     /// let y: Result<&str, &str> = Ok("foo");
 572     /// assert_eq!(x.and(y), Err("early error"));
 573     ///
 574     /// let x: Result<u32, &str> = Err("not a 2");
 575     /// let y: Result<&str, &str> = Err("late error");
 576     /// assert_eq!(x.and(y), Err("not a 2"));
 577     ///
 578     /// let x: Result<u32, &str> = Ok(2);
 579     /// let y: Result<&str, &str> = Ok("different result type");
 580     /// assert_eq!(x.and(y), Ok("different result type"));
 581     /// ```
 582     #[inline]
 583     #[stable(feature = "rust1", since = "1.0.0")]
 584     pub fn and<U>(self, res: Result<U, E>) -> Result<U, E> {
 585         match self {
 586             Ok(_) => res,
 587             Err(e) => Err(e),
 588         }
 589     }
 590
 591     /// Calls `op` if the result is `Ok`, otherwise returns the `Err` value of `self`.
 592     ///
 593     /// This function can be used for control flow based on result values.
 594     ///
 595     /// # Examples
 596     ///
 597     /// ```
 598     /// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
 599     /// fn err(x: u32) -> Result<u32, u32> { Err(x) }
 600     ///
 601     /// assert_eq!(Ok(2).and_then(sq).and_then(sq), Ok(16));
 602     /// assert_eq!(Ok(2).and_then(sq).and_then(err), Err(4));
 603     /// assert_eq!(Ok(2).and_then(err).and_then(sq), Err(2));
 604     /// assert_eq!(Err(3).and_then(sq).and_then(sq), Err(3));
 605     /// ```
 606     #[inline]
 607     #[stable(feature = "rust1", since = "1.0.0")]
 608     pub fn and_then<U, F: FnOnce(T) -> Result<U, E>>(self, op: F) -> Result<U, E> {
 609         match self {
 610             Ok(t) => op(t),
 611             Err(e) => Err(e),
 612         }
 613     }
 614
 615     /// Returns `res` if the result is `Err`, otherwise returns the `Ok` value of `self`.
 616     ///
 617     /// # Examples
 618     ///
 619     /// ```
 620     /// let x: Result<u32, &str> = Ok(2);
 621     /// let y: Result<u32, &str> = Err("late error");
 622     /// assert_eq!(x.or(y), Ok(2));
 623     ///
 624     /// let x: Result<u32, &str> = Err("early error");
 625     /// let y: Result<u32, &str> = Ok(2);
 626     /// assert_eq!(x.or(y), Ok(2));
 627     ///
 628     /// let x: Result<u32, &str> = Err("not a 2");
 629     /// let y: Result<u32, &str> = Err("late error");
 630     /// assert_eq!(x.or(y), Err("late error"));
 631     ///
 632     /// let x: Result<u32, &str> = Ok(2);
 633     /// let y: Result<u32, &str> = Ok(100);
 634     /// assert_eq!(x.or(y), Ok(2));
 635     /// ```
 636     #[inline]
 637     #[stable(feature = "rust1", since = "1.0.0")]
 638     pub fn or<F>(self, res: Result<T, F>) -> Result<T, F> {
 639         match self {
 640             Ok(v) => Ok(v),
 641             Err(_) => res,
 642         }
 643     }
 644
 645     /// Calls `op` if the result is `Err`, otherwise returns the `Ok` value of `self`.
 646     ///
 647     /// This function can be used for control flow based on result values.
 648     ///
 649     /// # Examples
 650     ///
 651     /// ```
 652     /// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
 653     /// fn err(x: u32) -> Result<u32, u32> { Err(x) }
 654     ///
 655     /// assert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));
 656     /// assert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));
 657     /// assert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));
 658     /// assert_eq!(Err(3).or_else(err).or_else(err), Err(3));
 659     /// ```
 660     #[inline]
 661     #[stable(feature = "rust1", since = "1.0.0")]
 662     pub fn or_else<F, O: FnOnce(E) -> Result<T, F>>(self, op: O) -> Result<T, F> {
 663         match self {
 664             Ok(t) => Ok(t),
 665             Err(e) => op(e),
 666         }
 667     }
 668
 669     /// Unwraps a result, yielding the content of an `Ok`.
 670     /// Else it returns `optb`.
 671     ///
 672     /// # Examples
 673     ///
 674     /// ```
 675     /// let optb = 2;
 676     /// let x: Result<u32, &str> = Ok(9);
 677     /// assert_eq!(x.unwrap_or(optb), 9);
 678     ///
 679     /// let x: Result<u32, &str> = Err("error");
 680     /// assert_eq!(x.unwrap_or(optb), optb);
 681     /// ```
 682     #[inline]
 683     #[stable(feature = "rust1", since = "1.0.0")]
 684     pub fn unwrap_or(self, optb: T) -> T {
 685         match self {
 686             Ok(t) => t,
 687             Err(_) => optb
 688         }
 689     }
 690
 691     /// Unwraps a result, yielding the content of an `Ok`.
 692     /// If the value is an `Err` then it calls `op` with its value.
 693     ///
 694     /// # Examples
 695     ///
 696     /// ```
 697     /// fn count(x: &str) -> usize { x.len() }
 698     ///
 699     /// assert_eq!(Ok(2).unwrap_or_else(count), 2);
 700     /// assert_eq!(Err("foo").unwrap_or_else(count), 3);
 701     /// ```
 702     #[inline]
 703     #[stable(feature = "rust1", since = "1.0.0")]
 704     pub fn unwrap_or_else<F: FnOnce(E) -> T>(self, op: F) -> T {
 705         match self {
 706             Ok(t) => t,
 707             Err(e) => op(e)
 708         }
 709     }
 710 }
 711
 712 #[stable(feature = "rust1", since = "1.0.0")]
 713 impl<T, E: fmt::Debug> Result<T, E> {
 714     /// Unwraps a result, yielding the content of an `Ok`.
 715     ///
 716     /// # Panics
 717     ///
 718     /// Panics if the value is an `Err`, with a panic message provided by the
 719     /// `Err`'s value.
 720     ///
 721     /// # Examples
 722     ///
 723     /// ```
 724     /// let x: Result<u32, &str> = Ok(2);
 725     /// assert_eq!(x.unwrap(), 2);
 726     /// ```
 727     ///
 728     /// ```{.should_panic}
 729     /// let x: Result<u32, &str> = Err("emergency failure");
 730     /// x.unwrap(); // panics with `emergency failure`
 731     /// ```
 732     #[inline]
 733     #[stable(feature = "rust1", since = "1.0.0")]
 734     pub fn unwrap(self) -> T {
 735         match self {
 736             Ok(t) => t,
 737             Err(e) =>
 738                 panic!("called `Result::unwrap()` on an `Err` value: {:?}", e)
 739         }
 740     }
 741
 742     /// Unwraps a result, yielding the content of an `Ok`.
 743     ///
 744     /// Panics if the value is an `Err`, with a panic message including the
 745     /// passed message, and the content of the `Err`.
 746     ///
 747     /// # Examples
 748     /// ```{.should_panic}
 749     /// let x: Result<u32, &str> = Err("emergency failure");
 750     /// x.expect("Testing expect"); // panics with `Testing expect: emergency failure`
 751     /// ```
 752     #[inline]
 753     #[stable(feature = "result_expect", since = "1.4.0")]
 754     pub fn expect(self, msg: &str) -> T {
 755         match self {
 756             Ok(t) => t,
 757             Err(e) => panic!("{}: {:?}", msg, e),
 758         }
 759     }
 760 }
 761
 762 #[stable(feature = "rust1", since = "1.0.0")]
 763 impl<T: fmt::Debug, E> Result<T, E> {
 764     /// Unwraps a result, yielding the content of an `Err`.
 765     ///
 766     /// # Panics
 767     ///
 768     /// Panics if the value is an `Ok`, with a custom panic message provided
 769     /// by the `Ok`'s value.
 770     ///
 771     /// # Examples
 772     ///
 773     /// ```{.should_panic}
 774     /// let x: Result<u32, &str> = Ok(2);
 775     /// x.unwrap_err(); // panics with `2`
 776     /// ```
 777     ///
 778     /// ```
 779     /// let x: Result<u32, &str> = Err("emergency failure");
 780     /// assert_eq!(x.unwrap_err(), "emergency failure");
 781     /// ```
 782     #[inline]
 783     #[stable(feature = "rust1", since = "1.0.0")]
 784     pub fn unwrap_err(self) -> E {
 785         match self {
 786             Ok(t) =>
 787                 panic!("called `Result::unwrap_err()` on an `Ok` value: {:?}", t),
 788             Err(e) => e
 789         }
 790     }
 791 }
 792
 793 /////////////////////////////////////////////////////////////////////////////
 794 // Trait implementations
 795 /////////////////////////////////////////////////////////////////////////////
 796
 797 #[stable(feature = "rust1", since = "1.0.0")]
 798 impl<T, E> IntoIterator for Result<T, E> {
 799     type Item = T;
 800     type IntoIter = IntoIter<T>;
 801
 802     /// Returns a consuming iterator over the possibly contained value.
 803     ///
 804     /// # Examples
 805     ///
 806     /// ```
 807     /// let x: Result<u32, &str> = Ok(5);
 808     /// let v: Vec<u32> = x.into_iter().collect();
 809     /// assert_eq!(v, [5]);
 810     ///
 811     /// let x: Result<u32, &str> = Err("nothing!");
 812     /// let v: Vec<u32> = x.into_iter().collect();
 813     /// assert_eq!(v, []);
 814     /// ```
 815     #[inline]
 816     fn into_iter(self) -> IntoIter<T> {
 817         IntoIter { inner: self.ok() }
 818     }
 819 }
 820
 821 #[stable(since = "1.4.0", feature = "result_iter")]
 822 impl<'a, T, E> IntoIterator for &'a Result<T, E> {
 823     type Item = &'a T;
 824     type IntoIter = Iter<'a, T>;
 825
 826     fn into_iter(self) -> Iter<'a, T> {
 827         self.iter()
 828     }
 829 }
 830
 831 #[stable(since = "1.4.0", feature = "result_iter")]
 832 impl<'a, T, E> IntoIterator for &'a mut Result<T, E> {
 833     type Item = &'a mut T;
 834     type IntoIter = IterMut<'a, T>;
 835
 836     fn into_iter(mut self) -> IterMut<'a, T> {
 837         self.iter_mut()
 838     }
 839 }
 840
 841 /////////////////////////////////////////////////////////////////////////////
 842 // The Result Iterators
 843 /////////////////////////////////////////////////////////////////////////////
 844
 845 /// An iterator over a reference to the `Ok` variant of a `Result`.
 846 #[stable(feature = "rust1", since = "1.0.0")]
 847 pub struct Iter<'a, T: 'a> { inner: Option<&'a T> }
 848
 849 #[stable(feature = "rust1", since = "1.0.0")]
 850 impl<'a, T> Iterator for Iter<'a, T> {
 851     type Item = &'a T;
 852
 853     #[inline]
 854     fn next(&mut self) -> Option<&'a T> { self.inner.take() }
 855     #[inline]
 856     fn size_hint(&self) -> (usize, Option<usize>) {
 857         let n = if self.inner.is_some() {1} else {0};
 858         (n, Some(n))
 859     }
 860 }
 861
 862 #[stable(feature = "rust1", since = "1.0.0")]
 863 impl<'a, T> DoubleEndedIterator for Iter<'a, T> {
 864     #[inline]
 865     fn next_back(&mut self) -> Option<&'a T> { self.inner.take() }
 866 }
 867
 868 #[stable(feature = "rust1", since = "1.0.0")]
 869 impl<'a, T> ExactSizeIterator for Iter<'a, T> {}
 870
 871 impl<'a, T> Clone for Iter<'a, T> {
 872     fn clone(&self) -> Iter<'a, T> { Iter { inner: self.inner } }
 873 }
 874
 875 /// An iterator over a mutable reference to the `Ok` variant of a `Result`.
 876 #[stable(feature = "rust1", since = "1.0.0")]
 877 pub struct IterMut<'a, T: 'a> { inner: Option<&'a mut T> }
 878
 879 #[stable(feature = "rust1", since = "1.0.0")]
 880 impl<'a, T> Iterator for IterMut<'a, T> {
 881     type Item = &'a mut T;
 882
 883     #[inline]
 884     fn next(&mut self) -> Option<&'a mut T> { self.inner.take() }
 885     #[inline]
 886     fn size_hint(&self) -> (usize, Option<usize>) {
 887         let n = if self.inner.is_some() {1} else {0};
 888         (n, Some(n))
 889     }
 890 }
 891
 892 #[stable(feature = "rust1", since = "1.0.0")]
 893 impl<'a, T> DoubleEndedIterator for IterMut<'a, T> {
 894     #[inline]
 895     fn next_back(&mut self) -> Option<&'a mut T> { self.inner.take() }
 896 }
 897
 898 #[stable(feature = "rust1", since = "1.0.0")]
 899 impl<'a, T> ExactSizeIterator for IterMut<'a, T> {}
 900
 901 /// An iterator over the value in a `Ok` variant of a `Result`.
 902 #[stable(feature = "rust1", since = "1.0.0")]
 903 pub struct IntoIter<T> { inner: Option<T> }
 904
 905 #[stable(feature = "rust1", since = "1.0.0")]
 906 impl<T> Iterator for IntoIter<T> {
 907     type Item = T;
 908
 909     #[inline]
 910     fn next(&mut self) -> Option<T> { self.inner.take() }
 911     #[inline]
 912     fn size_hint(&self) -> (usize, Option<usize>) {
 913         let n = if self.inner.is_some() {1} else {0};
 914         (n, Some(n))
 915     }
 916 }
 917
 918 #[stable(feature = "rust1", since = "1.0.0")]
 919 impl<T> DoubleEndedIterator for IntoIter<T> {
 920     #[inline]
 921     fn next_back(&mut self) -> Option<T> { self.inner.take() }
 922 }
 923
 924 #[stable(feature = "rust1", since = "1.0.0")]
 925 impl<T> ExactSizeIterator for IntoIter<T> {}
 926
 927 /////////////////////////////////////////////////////////////////////////////
 928 // FromIterator
 929 /////////////////////////////////////////////////////////////////////////////
 930
 931 #[stable(feature = "rust1", since = "1.0.0")]
 932 impl<A, E, V: FromIterator<A>> FromIterator<Result<A, E>> for Result<V, E> {
 933     /// Takes each element in the `Iterator`: if it is an `Err`, no further
 934     /// elements are taken, and the `Err` is returned. Should no `Err` occur, a
 935     /// container with the values of each `Result` is returned.
 936     ///
 937     /// Here is an example which increments every integer in a vector,
 938     /// checking for overflow:
 939     ///
 940     /// ```
 941     /// use std::u32;
 942     ///
 943     /// let v = vec!(1, 2);
 944     /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|&x: &u32|
 945     ///     if x == u32::MAX { Err("Overflow!") }
 946     ///     else { Ok(x + 1) }
 947     /// ).collect();
 948     /// assert!(res == Ok(vec!(2, 3)));
 949     /// ```
 950     #[inline]
 951     fn from_iter<I: IntoIterator<Item=Result<A, E>>>(iter: I) -> Result<V, E> {
 952         // FIXME(#11084): This could be replaced with Iterator::scan when this
 953         // performance bug is closed.
 954
 955         struct Adapter<Iter, E> {
 956             iter: Iter,
 957             err: Option<E>,
 958         }
 959
 960         impl<T, E, Iter: Iterator<Item=Result<T, E>>> Iterator for Adapter<Iter, E> {
 961             type Item = T;
 962
 963             #[inline]
 964             fn next(&mut self) -> Option<T> {
 965                 match self.iter.next() {
 966                     Some(Ok(value)) => Some(value),
 967                     Some(Err(err)) => {
 968                         self.err = Some(err);
 969                         None
 970                     }
 971                     None => None,
 972                 }
 973             }
 974         }
 975
 976         let mut adapter = Adapter { iter: iter.into_iter(), err: None };
 977         let v: V = FromIterator::from_iter(adapter.by_ref());
 978
 979         match adapter.err {
 980             Some(err) => Err(err),
 981             None => Ok(v),
 982         }
 983     }
 984 }