src/libcore/result.rs

   1 //! Error handling with the `Result` type.
   2 //!
   3 //! [`Result<T, E>`][`Result`] is the type used for returning and propagating
   4 //! errors. It is an enum with the variants, [`Ok(T)`], representing
   5 //! success and containing a value, and [`Err(E)`], representing error
   6 //! and containing an error value.
   7 //!
   8 //! ```
   9 //! # #[allow(dead_code)]
  10 //! enum Result<T, E> {
  11 //!    Ok(T),
  12 //!    Err(E),
  13 //! }
  14 //! ```
  15 //!
  16 //! Functions return [`Result`] whenever errors are expected and
  17 //! recoverable. In the `std` crate, [`Result`] is most prominently used
  18 //! for [I/O](../../std/io/index.html).
  19 //!
  20 //! A simple function returning [`Result`] might be
  21 //! defined and used like so:
  22 //!
  23 //! ```
  24 //! #[derive(Debug)]
  25 //! enum Version { Version1, Version2 }
  26 //!
  27 //! fn parse_version(header: &[u8]) -> Result<Version, &'static str> {
  28 //!     match header.get(0) {
  29 //!         None => Err("invalid header length"),
  30 //!         Some(&1) => Ok(Version::Version1),
  31 //!         Some(&2) => Ok(Version::Version2),
  32 //!         Some(_) => Err("invalid version"),
  33 //!     }
  34 //! }
  35 //!
  36 //! let version = parse_version(&[1, 2, 3, 4]);
  37 //! match version {
  38 //!     Ok(v) => println!("working with version: {:?}", v),
  39 //!     Err(e) => println!("error parsing header: {:?}", e),
  40 //! }
  41 //! ```
  42 //!
  43 //! Pattern matching on [`Result`]s is clear and straightforward for
  44 //! simple cases, but [`Result`] comes with some convenience methods
  45 //! that make working with it more succinct.
  46 //!
  47 //! ```
  48 //! let good_result: Result<i32, i32> = Ok(10);
  49 //! let bad_result: Result<i32, i32> = Err(10);
  50 //!
  51 //! // The `is_ok` and `is_err` methods do what they say.
  52 //! assert!(good_result.is_ok() && !good_result.is_err());
  53 //! assert!(bad_result.is_err() && !bad_result.is_ok());
  54 //!
  55 //! // `map` consumes the `Result` and produces another.
  56 //! let good_result: Result<i32, i32> = good_result.map(|i| i + 1);
  57 //! let bad_result: Result<i32, i32> = bad_result.map(|i| i - 1);
  58 //!
  59 //! // Use `and_then` to continue the computation.
  60 //! let good_result: Result<bool, i32> = good_result.and_then(|i| Ok(i == 11));
  61 //!
  62 //! // Use `or_else` to handle the error.
  63 //! let bad_result: Result<i32, i32> = bad_result.or_else(|i| Ok(i + 20));
  64 //!
  65 //! // Consume the result and return the contents with `unwrap`.
  66 //! let final_awesome_result = good_result.unwrap();
  67 //! ```
  68 //!
  69 //! # Results must be used
  70 //!
  71 //! A common problem with using return values to indicate errors is
  72 //! that it is easy to ignore the return value, thus failing to handle
  73 //! the error. [`Result`] is annotated with the `#[must_use]` attribute,
  74 //! which will cause the compiler to issue a warning when a Result
  75 //! value is ignored. This makes [`Result`] especially useful with
  76 //! functions that may encounter errors but don't otherwise return a
  77 //! useful value.
  78 //!
  79 //! Consider the [`write_all`] method defined for I/O types
  80 //! by the [`Write`] trait:
  81 //!
  82 //! ```
  83 //! use std::io;
  84 //!
  85 //! trait Write {
  86 //!     fn write_all(&mut self, bytes: &[u8]) -> Result<(), io::Error>;
  87 //! }
  88 //! ```
  89 //!
  90 //! *Note: The actual definition of [`Write`] uses [`io::Result`], which
  91 //! is just a synonym for [`Result`]`<T, `[`io::Error`]`>`.*
  92 //!
  93 //! This method doesn't produce a value, but the write may
  94 //! fail. It's crucial to handle the error case, and *not* write
  95 //! something like this:
  96 //!
  97 //! ```no_run
  98 //! # #![allow(unused_must_use)] // \o/
  99 //! use std::fs::File;
 100 //! use std::io::prelude::*;
 101 //!
 102 //! let mut file = File::create("valuable_data.txt").unwrap();
 103 //! // If `write_all` errors, then we'll never know, because the return
 104 //! // value is ignored.
 105 //! file.write_all(b"important message");
 106 //! ```
 107 //!
 108 //! If you *do* write that in Rust, the compiler will give you a
 109 //! warning (by default, controlled by the `unused_must_use` lint).
 110 //!
 111 //! You might instead, if you don't want to handle the error, simply
 112 //! assert success with [`expect`]. This will panic if the
 113 //! write fails, providing a marginally useful message indicating why:
 114 //!
 115 //! ```{.no_run}
 116 //! use std::fs::File;
 117 //! use std::io::prelude::*;
 118 //!
 119 //! let mut file = File::create("valuable_data.txt").unwrap();
 120 //! file.write_all(b"important message").expect("failed to write message");
 121 //! ```
 122 //!
 123 //! You might also simply assert success:
 124 //!
 125 //! ```{.no_run}
 126 //! # use std::fs::File;
 127 //! # use std::io::prelude::*;
 128 //! # let mut file = File::create("valuable_data.txt").unwrap();
 129 //! assert!(file.write_all(b"important message").is_ok());
 130 //! ```
 131 //!
 132 //! Or propagate the error up the call stack with [`?`]:
 133 //!
 134 //! ```
 135 //! # use std::fs::File;
 136 //! # use std::io::prelude::*;
 137 //! # use std::io;
 138 //! # #[allow(dead_code)]
 139 //! fn write_message() -> io::Result<()> {
 140 //!     let mut file = File::create("valuable_data.txt")?;
 141 //!     file.write_all(b"important message")?;
 142 //!     Ok(())
 143 //! }
 144 //! ```
 145 //!
 146 //! # The question mark operator, `?`
 147 //!
 148 //! When writing code that calls many functions that return the
 149 //! [`Result`] type, the error handling can be tedious. The question mark
 150 //! operator, [`?`], hides some of the boilerplate of propagating errors
 151 //! up the call stack.
 152 //!
 153 //! It replaces this:
 154 //!
 155 //! ```
 156 //! # #![allow(dead_code)]
 157 //! use std::fs::File;
 158 //! use std::io::prelude::*;
 159 //! use std::io;
 160 //!
 161 //! struct Info {
 162 //!     name: String,
 163 //!     age: i32,
 164 //!     rating: i32,
 165 //! }
 166 //!
 167 //! fn write_info(info: &Info) -> io::Result<()> {
 168 //!     // Early return on error
 169 //!     let mut file = match File::create("my_best_friends.txt") {
 170 //!            Err(e) => return Err(e),
 171 //!            Ok(f) => f,
 172 //!     };
 173 //!     if let Err(e) = file.write_all(format!("name: {}\n", info.name).as_bytes()) {
 174 //!         return Err(e)
 175 //!     }
 176 //!     if let Err(e) = file.write_all(format!("age: {}\n", info.age).as_bytes()) {
 177 //!         return Err(e)
 178 //!     }
 179 //!     if let Err(e) = file.write_all(format!("rating: {}\n", info.rating).as_bytes()) {
 180 //!         return Err(e)
 181 //!     }
 182 //!     Ok(())
 183 //! }
 184 //! ```
 185 //!
 186 //! With this:
 187 //!
 188 //! ```
 189 //! # #![allow(dead_code)]
 190 //! use std::fs::File;
 191 //! use std::io::prelude::*;
 192 //! use std::io;
 193 //!
 194 //! struct Info {
 195 //!     name: String,
 196 //!     age: i32,
 197 //!     rating: i32,
 198 //! }
 199 //!
 200 //! fn write_info(info: &Info) -> io::Result<()> {
 201 //!     let mut file = File::create("my_best_friends.txt")?;
 202 //!     // Early return on error
 203 //!     file.write_all(format!("name: {}\n", info.name).as_bytes())?;
 204 //!     file.write_all(format!("age: {}\n", info.age).as_bytes())?;
 205 //!     file.write_all(format!("rating: {}\n", info.rating).as_bytes())?;
 206 //!     Ok(())
 207 //! }
 208 //! ```
 209 //!
 210 //! *It's much nicer!*
 211 //!
 212 //! Ending the expression with [`?`] will result in the unwrapped
 213 //! success ([`Ok`]) value, unless the result is [`Err`], in which case
 214 //! [`Err`] is returned early from the enclosing function.
 215 //!
 216 //! [`?`] can only be used in functions that return [`Result`] because of the
 217 //! early return of [`Err`] that it provides.
 218 //!
 219 //! [`expect`]: enum.Result.html#method.expect
 220 //! [`Write`]: ../../std/io/trait.Write.html
 221 //! [`write_all`]: ../../std/io/trait.Write.html#method.write_all
 222 //! [`io::Result`]: ../../std/io/type.Result.html
 223 //! [`?`]: ../../std/macro.try.html
 224 //! [`Result`]: enum.Result.html
 225 //! [`Ok(T)`]: enum.Result.html#variant.Ok
 226 //! [`Err(E)`]: enum.Result.html#variant.Err
 227 //! [`io::Error`]: ../../std/io/struct.Error.html
 228 //! [`Ok`]: enum.Result.html#variant.Ok
 229 //! [`Err`]: enum.Result.html#variant.Err
 230
 231 #![stable(feature = "rust1", since = "1.0.0")]
 232
 233 use crate::fmt;
 234 use crate::iter::{self, FromIterator, FusedIterator, TrustedLen};
 235 use crate::ops::{self, Deref, DerefMut};
 236
 237 /// `Result` is a type that represents either success ([`Ok`]) or failure ([`Err`]).
 238 ///
 239 /// See the [`std::result`](index.html) module documentation for details.
 240 ///
 241 /// [`Ok`]: enum.Result.html#variant.Ok
 242 /// [`Err`]: enum.Result.html#variant.Err
 243 #[derive(Copy, PartialEq, PartialOrd, Eq, Ord, Debug, Hash)]
 244 #[must_use = "this `Result` may be an `Err` variant, which should be handled"]
 245 #[stable(feature = "rust1", since = "1.0.0")]
 246 pub enum Result<T, E> {
 247     /// Contains the success value
 248     #[stable(feature = "rust1", since = "1.0.0")]
 249     Ok(#[stable(feature = "rust1", since = "1.0.0")] T),
 250
 251     /// Contains the error value
 252     #[stable(feature = "rust1", since = "1.0.0")]
 253     Err(#[stable(feature = "rust1", since = "1.0.0")] E),
 254 }
 255
 256 /////////////////////////////////////////////////////////////////////////////
 257 // Type implementation
 258 /////////////////////////////////////////////////////////////////////////////
 259
 260 impl<T, E> Result<T, E> {
 261     /////////////////////////////////////////////////////////////////////////
 262     // Querying the contained values
 263     /////////////////////////////////////////////////////////////////////////
 264
 265     /// Returns `true` if the result is [`Ok`].
 266     ///
 267     /// [`Ok`]: enum.Result.html#variant.Ok
 268     ///
 269     /// # Examples
 270     ///
 271     /// Basic usage:
 272     ///
 273     /// ```
 274     /// let x: Result<i32, &str> = Ok(-3);
 275     /// assert_eq!(x.is_ok(), true);
 276     ///
 277     /// let x: Result<i32, &str> = Err("Some error message");
 278     /// assert_eq!(x.is_ok(), false);
 279     /// ```
 280     #[must_use = "if you intended to assert that this is ok, consider `.unwrap()` instead"]
 281     #[inline]
 282     #[stable(feature = "rust1", since = "1.0.0")]
 283     pub fn is_ok(&self) -> bool {
 284         match *self {
 285             Ok(_) => true,
 286             Err(_) => false
 287         }
 288     }
 289
 290     /// Returns `true` if the result is [`Err`].
 291     ///
 292     /// [`Err`]: enum.Result.html#variant.Err
 293     ///
 294     /// # Examples
 295     ///
 296     /// Basic usage:
 297     ///
 298     /// ```
 299     /// let x: Result<i32, &str> = Ok(-3);
 300     /// assert_eq!(x.is_err(), false);
 301     ///
 302     /// let x: Result<i32, &str> = Err("Some error message");
 303     /// assert_eq!(x.is_err(), true);
 304     /// ```
 305     #[must_use = "if you intended to assert that this is err, consider `.unwrap_err()` instead"]
 306     #[inline]
 307     #[stable(feature = "rust1", since = "1.0.0")]
 308     pub fn is_err(&self) -> bool {
 309         !self.is_ok()
 310     }
 311
 312     /// Returns `true` if the result is an [`Ok`] value containing the given value.
 313     ///
 314     /// # Examples
 315     ///
 316     /// ```
 317     /// #![feature(option_result_contains)]
 318     ///
 319     /// let x: Result<u32, &str> = Ok(2);
 320     /// assert_eq!(x.contains(&2), true);
 321     ///
 322     /// let x: Result<u32, &str> = Ok(3);
 323     /// assert_eq!(x.contains(&2), false);
 324     ///
 325     /// let x: Result<u32, &str> = Err("Some error message");
 326     /// assert_eq!(x.contains(&2), false);
 327     /// ```
 328     #[must_use]
 329     #[inline]
 330     #[unstable(feature = "option_result_contains", issue = "62358")]
 331     pub fn contains<U>(&self, x: &U) -> bool where U: PartialEq<T> {
 332         match self {
 333             Ok(y) => x == y,
 334             Err(_) => false
 335         }
 336     }
 337
 338     /// Returns `true` if the result is an [`Err`] value containing the given value.
 339     ///
 340     /// # Examples
 341     ///
 342     /// ```
 343     /// #![feature(result_contains_err)]
 344     ///
 345     /// let x: Result<u32, &str> = Ok(2);
 346     /// assert_eq!(x.contains_err(&"Some error message"), false);
 347     ///
 348     /// let x: Result<u32, &str> = Err("Some error message");
 349     /// assert_eq!(x.contains_err(&"Some error message"), true);
 350     ///
 351     /// let x: Result<u32, &str> = Err("Some other error message");
 352     /// assert_eq!(x.contains_err(&"Some error message"), false);
 353     /// ```
 354     #[must_use]
 355     #[inline]
 356     #[unstable(feature = "result_contains_err", issue = "62358")]
 357     pub fn contains_err<F>(&self, f: &F) -> bool where F: PartialEq<E> {
 358         match self {
 359             Ok(_) => false,
 360             Err(e) => f == e
 361         }
 362     }
 363
 364     /////////////////////////////////////////////////////////////////////////
 365     // Adapter for each variant
 366     /////////////////////////////////////////////////////////////////////////
 367
 368     /// Converts from `Result<T, E>` to [`Option<T>`].
 369     ///
 370     /// Converts `self` into an [`Option<T>`], consuming `self`,
 371     /// and discarding the error, if any.
 372     ///
 373     /// [`Option<T>`]: ../../std/option/enum.Option.html
 374     ///
 375     /// # Examples
 376     ///
 377     /// Basic usage:
 378     ///
 379     /// ```
 380     /// let x: Result<u32, &str> = Ok(2);
 381     /// assert_eq!(x.ok(), Some(2));
 382     ///
 383     /// let x: Result<u32, &str> = Err("Nothing here");
 384     /// assert_eq!(x.ok(), None);
 385     /// ```
 386     #[inline]
 387     #[stable(feature = "rust1", since = "1.0.0")]
 388     pub fn ok(self) -> Option<T> {
 389         match self {
 390             Ok(x)  => Some(x),
 391             Err(_) => None,
 392         }
 393     }
 394
 395     /// Converts from `Result<T, E>` to [`Option<E>`].
 396     ///
 397     /// Converts `self` into an [`Option<E>`], consuming `self`,
 398     /// and discarding the success value, if any.
 399     ///
 400     /// [`Option<E>`]: ../../std/option/enum.Option.html
 401     ///
 402     /// # Examples
 403     ///
 404     /// Basic usage:
 405     ///
 406     /// ```
 407     /// let x: Result<u32, &str> = Ok(2);
 408     /// assert_eq!(x.err(), None);
 409     ///
 410     /// let x: Result<u32, &str> = Err("Nothing here");
 411     /// assert_eq!(x.err(), Some("Nothing here"));
 412     /// ```
 413     #[inline]
 414     #[stable(feature = "rust1", since = "1.0.0")]
 415     pub fn err(self) -> Option<E> {
 416         match self {
 417             Ok(_)  => None,
 418             Err(x) => Some(x),
 419         }
 420     }
 421
 422     /////////////////////////////////////////////////////////////////////////
 423     // Adapter for working with references
 424     /////////////////////////////////////////////////////////////////////////
 425
 426     /// Converts from `&Result<T, E>` to `Result<&T, &E>`.
 427     ///
 428     /// Produces a new `Result`, containing a reference
 429     /// into the original, leaving the original in place.
 430     ///
 431     /// # Examples
 432     ///
 433     /// Basic usage:
 434     ///
 435     /// ```
 436     /// let x: Result<u32, &str> = Ok(2);
 437     /// assert_eq!(x.as_ref(), Ok(&2));
 438     ///
 439     /// let x: Result<u32, &str> = Err("Error");
 440     /// assert_eq!(x.as_ref(), Err(&"Error"));
 441     /// ```
 442     #[inline]
 443     #[stable(feature = "rust1", since = "1.0.0")]
 444     pub fn as_ref(&self) -> Result<&T, &E> {
 445         match *self {
 446             Ok(ref x) => Ok(x),
 447             Err(ref x) => Err(x),
 448         }
 449     }
 450
 451     /// Converts from `&mut Result<T, E>` to `Result<&mut T, &mut E>`.
 452     ///
 453     /// # Examples
 454     ///
 455     /// Basic usage:
 456     ///
 457     /// ```
 458     /// fn mutate(r: &mut Result<i32, i32>) {
 459     ///     match r.as_mut() {
 460     ///         Ok(v) => *v = 42,
 461     ///         Err(e) => *e = 0,
 462     ///     }
 463     /// }
 464     ///
 465     /// let mut x: Result<i32, i32> = Ok(2);
 466     /// mutate(&mut x);
 467     /// assert_eq!(x.unwrap(), 42);
 468     ///
 469     /// let mut x: Result<i32, i32> = Err(13);
 470     /// mutate(&mut x);
 471     /// assert_eq!(x.unwrap_err(), 0);
 472     /// ```
 473     #[inline]
 474     #[stable(feature = "rust1", since = "1.0.0")]
 475     pub fn as_mut(&mut self) -> Result<&mut T, &mut E> {
 476         match *self {
 477             Ok(ref mut x) => Ok(x),
 478             Err(ref mut x) => Err(x),
 479         }
 480     }
 481
 482     /////////////////////////////////////////////////////////////////////////
 483     // Transforming contained values
 484     /////////////////////////////////////////////////////////////////////////
 485
 486     /// Maps a `Result<T, E>` to `Result<U, E>` by applying a function to a
 487     /// contained [`Ok`] value, leaving an [`Err`] value untouched.
 488     ///
 489     /// This function can be used to compose the results of two functions.
 490     ///
 491     /// [`Ok`]: enum.Result.html#variant.Ok
 492     /// [`Err`]: enum.Result.html#variant.Err
 493     ///
 494     /// # Examples
 495     ///
 496     /// Print the numbers on each line of a string multiplied by two.
 497     ///
 498     /// ```
 499     /// let line = "1\n2\n3\n4\n";
 500     ///
 501     /// for num in line.lines() {
 502     ///     match num.parse::<i32>().map(|i| i * 2) {
 503     ///         Ok(n) => println!("{}", n),
 504     ///         Err(..) => {}
 505     ///     }
 506     /// }
 507     /// ```
 508     #[inline]
 509     #[stable(feature = "rust1", since = "1.0.0")]
 510     pub fn map<U, F: FnOnce(T) -> U>(self, op: F) -> Result<U,E> {
 511         match self {
 512             Ok(t) => Ok(op(t)),
 513             Err(e) => Err(e)
 514         }
 515     }
 516
 517     /// Applies a function to the contained value (if any),
 518     /// or returns the provided default (if not).
 519     ///
 520     /// # Examples
 521     ///
 522     /// ```
 523     /// #![feature(result_map_or)]
 524     /// let x: Result<_, &str> = Ok("foo");
 525     /// assert_eq!(x.map_or(42, |v| v.len()), 3);
 526     ///
 527     /// let x: Result<&str, _> = Err("bar");
 528     /// assert_eq!(x.map_or(42, |v| v.len()), 42);
 529     /// ```
 530     #[inline]
 531     #[unstable(feature = "result_map_or", issue = "66293")]
 532     pub fn map_or<U, F: FnOnce(T) -> U>(self, default: U, f: F) -> U {
 533         match self {
 534             Ok(t) => f(t),
 535             Err(_) => default,
 536         }
 537     }
 538
 539     /// Maps a `Result<T, E>` to `U` by applying a function to a
 540     /// contained [`Ok`] value, or a fallback function to a
 541     /// contained [`Err`] value.
 542     ///
 543     /// This function can be used to unpack a successful result
 544     /// while handling an error.
 545     ///
 546     /// [`Ok`]: enum.Result.html#variant.Ok
 547     /// [`Err`]: enum.Result.html#variant.Err
 548     ///
 549     /// # Examples
 550     ///
 551     /// Basic usage:
 552     ///
 553     /// ```
 554     /// let k = 21;
 555     ///
 556     /// let x : Result<_, &str> = Ok("foo");
 557     /// assert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);
 558     ///
 559     /// let x : Result<&str, _> = Err("bar");
 560     /// assert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
 561     /// ```
 562     #[inline]
 563     #[stable(feature = "result_map_or_else", since = "1.41.0")]
 564     pub fn map_or_else<U, D: FnOnce(E) -> U, F: FnOnce(T) -> U>(self, default: D, f: F) -> U {
 565         match self {
 566             Ok(t) => f(t),
 567             Err(e) => default(e),
 568         }
 569     }
 570
 571     /// Maps a `Result<T, E>` to `Result<T, F>` by applying a function to a
 572     /// contained [`Err`] value, leaving an [`Ok`] value untouched.
 573     ///
 574     /// This function can be used to pass through a successful result while handling
 575     /// an error.
 576     ///
 577     /// [`Ok`]: enum.Result.html#variant.Ok
 578     /// [`Err`]: enum.Result.html#variant.Err
 579     ///
 580     /// # Examples
 581     ///
 582     /// Basic usage:
 583     ///
 584     /// ```
 585     /// fn stringify(x: u32) -> String { format!("error code: {}", x) }
 586     ///
 587     /// let x: Result<u32, u32> = Ok(2);
 588     /// assert_eq!(x.map_err(stringify), Ok(2));
 589     ///
 590     /// let x: Result<u32, u32> = Err(13);
 591     /// assert_eq!(x.map_err(stringify), Err("error code: 13".to_string()));
 592     /// ```
 593     #[inline]
 594     #[stable(feature = "rust1", since = "1.0.0")]
 595     pub fn map_err<F, O: FnOnce(E) -> F>(self, op: O) -> Result<T,F> {
 596         match self {
 597             Ok(t) => Ok(t),
 598             Err(e) => Err(op(e))
 599         }
 600     }
 601
 602     /////////////////////////////////////////////////////////////////////////
 603     // Iterator constructors
 604     /////////////////////////////////////////////////////////////////////////
 605
 606     /// Returns an iterator over the possibly contained value.
 607     ///
 608     /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
 609     ///
 610     /// # Examples
 611     ///
 612     /// Basic usage:
 613     ///
 614     /// ```
 615     /// let x: Result<u32, &str> = Ok(7);
 616     /// assert_eq!(x.iter().next(), Some(&7));
 617     ///
 618     /// let x: Result<u32, &str> = Err("nothing!");
 619     /// assert_eq!(x.iter().next(), None);
 620     /// ```
 621     #[inline]
 622     #[stable(feature = "rust1", since = "1.0.0")]
 623     pub fn iter(&self) -> Iter<'_, T> {
 624         Iter { inner: self.as_ref().ok() }
 625     }
 626
 627     /// Returns a mutable iterator over the possibly contained value.
 628     ///
 629     /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
 630     ///
 631     /// # Examples
 632     ///
 633     /// Basic usage:
 634     ///
 635     /// ```
 636     /// let mut x: Result<u32, &str> = Ok(7);
 637     /// match x.iter_mut().next() {
 638     ///     Some(v) => *v = 40,
 639     ///     None => {},
 640     /// }
 641     /// assert_eq!(x, Ok(40));
 642     ///
 643     /// let mut x: Result<u32, &str> = Err("nothing!");
 644     /// assert_eq!(x.iter_mut().next(), None);
 645     /// ```
 646     #[inline]
 647     #[stable(feature = "rust1", since = "1.0.0")]
 648     pub fn iter_mut(&mut self) -> IterMut<'_, T> {
 649         IterMut { inner: self.as_mut().ok() }
 650     }
 651
 652     ////////////////////////////////////////////////////////////////////////
 653     // Boolean operations on the values, eager and lazy
 654     /////////////////////////////////////////////////////////////////////////
 655
 656     /// Returns `res` if the result is [`Ok`], otherwise returns the [`Err`] value of `self`.
 657     ///
 658     /// [`Ok`]: enum.Result.html#variant.Ok
 659     /// [`Err`]: enum.Result.html#variant.Err
 660     ///
 661     /// # Examples
 662     ///
 663     /// Basic usage:
 664     ///
 665     /// ```
 666     /// let x: Result<u32, &str> = Ok(2);
 667     /// let y: Result<&str, &str> = Err("late error");
 668     /// assert_eq!(x.and(y), Err("late error"));
 669     ///
 670     /// let x: Result<u32, &str> = Err("early error");
 671     /// let y: Result<&str, &str> = Ok("foo");
 672     /// assert_eq!(x.and(y), Err("early error"));
 673     ///
 674     /// let x: Result<u32, &str> = Err("not a 2");
 675     /// let y: Result<&str, &str> = Err("late error");
 676     /// assert_eq!(x.and(y), Err("not a 2"));
 677     ///
 678     /// let x: Result<u32, &str> = Ok(2);
 679     /// let y: Result<&str, &str> = Ok("different result type");
 680     /// assert_eq!(x.and(y), Ok("different result type"));
 681     /// ```
 682     #[inline]
 683     #[stable(feature = "rust1", since = "1.0.0")]
 684     pub fn and<U>(self, res: Result<U, E>) -> Result<U, E> {
 685         match self {
 686             Ok(_) => res,
 687             Err(e) => Err(e),
 688         }
 689     }
 690
 691     /// Calls `op` if the result is [`Ok`], otherwise returns the [`Err`] value of `self`.
 692     ///
 693     /// [`Ok`]: enum.Result.html#variant.Ok
 694     /// [`Err`]: enum.Result.html#variant.Err
 695     ///
 696     /// This function can be used for control flow based on `Result` values.
 697     ///
 698     /// # Examples
 699     ///
 700     /// Basic usage:
 701     ///
 702     /// ```
 703     /// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
 704     /// fn err(x: u32) -> Result<u32, u32> { Err(x) }
 705     ///
 706     /// assert_eq!(Ok(2).and_then(sq).and_then(sq), Ok(16));
 707     /// assert_eq!(Ok(2).and_then(sq).and_then(err), Err(4));
 708     /// assert_eq!(Ok(2).and_then(err).and_then(sq), Err(2));
 709     /// assert_eq!(Err(3).and_then(sq).and_then(sq), Err(3));
 710     /// ```
 711     #[inline]
 712     #[stable(feature = "rust1", since = "1.0.0")]
 713     pub fn and_then<U, F: FnOnce(T) -> Result<U, E>>(self, op: F) -> Result<U, E> {
 714         match self {
 715             Ok(t) => op(t),
 716             Err(e) => Err(e),
 717         }
 718     }
 719
 720     /// Returns `res` if the result is [`Err`], otherwise returns the [`Ok`] value of `self`.
 721     ///
 722     /// Arguments passed to `or` are eagerly evaluated; if you are passing the
 723     /// result of a function call, it is recommended to use [`or_else`], which is
 724     /// lazily evaluated.
 725     ///
 726     /// [`Ok`]: enum.Result.html#variant.Ok
 727     /// [`Err`]: enum.Result.html#variant.Err
 728     /// [`or_else`]: #method.or_else
 729     ///
 730     /// # Examples
 731     ///
 732     /// Basic usage:
 733     ///
 734     /// ```
 735     /// let x: Result<u32, &str> = Ok(2);
 736     /// let y: Result<u32, &str> = Err("late error");
 737     /// assert_eq!(x.or(y), Ok(2));
 738     ///
 739     /// let x: Result<u32, &str> = Err("early error");
 740     /// let y: Result<u32, &str> = Ok(2);
 741     /// assert_eq!(x.or(y), Ok(2));
 742     ///
 743     /// let x: Result<u32, &str> = Err("not a 2");
 744     /// let y: Result<u32, &str> = Err("late error");
 745     /// assert_eq!(x.or(y), Err("late error"));
 746     ///
 747     /// let x: Result<u32, &str> = Ok(2);
 748     /// let y: Result<u32, &str> = Ok(100);
 749     /// assert_eq!(x.or(y), Ok(2));
 750     /// ```
 751     #[inline]
 752     #[stable(feature = "rust1", since = "1.0.0")]
 753     pub fn or<F>(self, res: Result<T, F>) -> Result<T, F> {
 754         match self {
 755             Ok(v) => Ok(v),
 756             Err(_) => res,
 757         }
 758     }
 759
 760     /// Calls `op` if the result is [`Err`], otherwise returns the [`Ok`] value of `self`.
 761     ///
 762     /// This function can be used for control flow based on result values.
 763     ///
 764     /// [`Ok`]: enum.Result.html#variant.Ok
 765     /// [`Err`]: enum.Result.html#variant.Err
 766     ///
 767     /// # Examples
 768     ///
 769     /// Basic usage:
 770     ///
 771     /// ```
 772     /// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
 773     /// fn err(x: u32) -> Result<u32, u32> { Err(x) }
 774     ///
 775     /// assert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));
 776     /// assert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));
 777     /// assert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));
 778     /// assert_eq!(Err(3).or_else(err).or_else(err), Err(3));
 779     /// ```
 780     #[inline]
 781     #[stable(feature = "rust1", since = "1.0.0")]
 782     pub fn or_else<F, O: FnOnce(E) -> Result<T, F>>(self, op: O) -> Result<T, F> {
 783         match self {
 784             Ok(t) => Ok(t),
 785             Err(e) => op(e),
 786         }
 787     }
 788
 789     /// Unwraps a result, yielding the content of an [`Ok`].
 790     /// Else, it returns `optb`.
 791     ///
 792     /// Arguments passed to `unwrap_or` are eagerly evaluated; if you are passing
 793     /// the result of a function call, it is recommended to use [`unwrap_or_else`],
 794     /// which is lazily evaluated.
 795     ///
 796     /// [`Ok`]: enum.Result.html#variant.Ok
 797     /// [`Err`]: enum.Result.html#variant.Err
 798     /// [`unwrap_or_else`]: #method.unwrap_or_else
 799     ///
 800     /// # Examples
 801     ///
 802     /// Basic usage:
 803     ///
 804     /// ```
 805     /// let optb = 2;
 806     /// let x: Result<u32, &str> = Ok(9);
 807     /// assert_eq!(x.unwrap_or(optb), 9);
 808     ///
 809     /// let x: Result<u32, &str> = Err("error");
 810     /// assert_eq!(x.unwrap_or(optb), optb);
 811     /// ```
 812     #[inline]
 813     #[stable(feature = "rust1", since = "1.0.0")]
 814     pub fn unwrap_or(self, optb: T) -> T {
 815         match self {
 816             Ok(t) => t,
 817             Err(_) => optb
 818         }
 819     }
 820
 821     /// Unwraps a result, yielding the content of an [`Ok`].
 822     /// If the value is an [`Err`] then it calls `op` with its value.
 823     ///
 824     /// [`Ok`]: enum.Result.html#variant.Ok
 825     /// [`Err`]: enum.Result.html#variant.Err
 826     ///
 827     /// # Examples
 828     ///
 829     /// Basic usage:
 830     ///
 831     /// ```
 832     /// fn count(x: &str) -> usize { x.len() }
 833     ///
 834     /// assert_eq!(Ok(2).unwrap_or_else(count), 2);
 835     /// assert_eq!(Err("foo").unwrap_or_else(count), 3);
 836     /// ```
 837     #[inline]
 838     #[stable(feature = "rust1", since = "1.0.0")]
 839     pub fn unwrap_or_else<F: FnOnce(E) -> T>(self, op: F) -> T {
 840         match self {
 841             Ok(t) => t,
 842             Err(e) => op(e)
 843         }
 844     }
 845 }
 846
 847 impl<T: Copy, E> Result<&T, E> {
 848     /// Maps a `Result<&T, E>` to a `Result<T, E>` by copying the contents of the
 849     /// `Ok` part.
 850     ///
 851     /// # Examples
 852     ///
 853     /// ```
 854     /// #![feature(result_copied)]
 855     /// let val = 12;
 856     /// let x: Result<&i32, i32> = Ok(&val);
 857     /// assert_eq!(x, Ok(&12));
 858     /// let copied = x.copied();
 859     /// assert_eq!(copied, Ok(12));
 860     /// ```
 861     #[unstable(feature = "result_copied", reason = "newly added", issue = "63168")]
 862     pub fn copied(self) -> Result<T, E> {
 863         self.map(|&t| t)
 864     }
 865 }
 866
 867 impl<T: Copy, E> Result<&mut T, E> {
 868     /// Maps a `Result<&mut T, E>` to a `Result<T, E>` by copying the contents of the
 869     /// `Ok` part.
 870     ///
 871     /// # Examples
 872     ///
 873     /// ```
 874     /// #![feature(result_copied)]
 875     /// let mut val = 12;
 876     /// let x: Result<&mut i32, i32> = Ok(&mut val);
 877     /// assert_eq!(x, Ok(&mut 12));
 878     /// let copied = x.copied();
 879     /// assert_eq!(copied, Ok(12));
 880     /// ```
 881     #[unstable(feature = "result_copied", reason = "newly added", issue = "63168")]
 882     pub fn copied(self) -> Result<T, E> {
 883         self.map(|&mut t| t)
 884     }
 885 }
 886
 887 impl<T: Clone, E> Result<&T, E> {
 888     /// Maps a `Result<&T, E>` to a `Result<T, E>` by cloning the contents of the
 889     /// `Ok` part.
 890     ///
 891     /// # Examples
 892     ///
 893     /// ```
 894     /// #![feature(result_cloned)]
 895     /// let val = 12;
 896     /// let x: Result<&i32, i32> = Ok(&val);
 897     /// assert_eq!(x, Ok(&12));
 898     /// let cloned = x.cloned();
 899     /// assert_eq!(cloned, Ok(12));
 900     /// ```
 901     #[unstable(feature = "result_cloned", reason = "newly added", issue = "63168")]
 902     pub fn cloned(self) -> Result<T, E> {
 903         self.map(|t| t.clone())
 904     }
 905 }
 906
 907 impl<T: Clone, E> Result<&mut T, E> {
 908     /// Maps a `Result<&mut T, E>` to a `Result<T, E>` by cloning the contents of the
 909     /// `Ok` part.
 910     ///
 911     /// # Examples
 912     ///
 913     /// ```
 914     /// #![feature(result_cloned)]
 915     /// let mut val = 12;
 916     /// let x: Result<&mut i32, i32> = Ok(&mut val);
 917     /// assert_eq!(x, Ok(&mut 12));
 918     /// let cloned = x.cloned();
 919     /// assert_eq!(cloned, Ok(12));
 920     /// ```
 921     #[unstable(feature = "result_cloned", reason = "newly added", issue = "63168")]
 922     pub fn cloned(self) -> Result<T, E> {
 923         self.map(|t| t.clone())
 924     }
 925 }
 926
 927
 928 impl<T, E: fmt::Debug> Result<T, E> {
 929     /// Unwraps a result, yielding the content of an [`Ok`].
 930     ///
 931     /// # Panics
 932     ///
 933     /// Panics if the value is an [`Err`], with a panic message provided by the
 934     /// [`Err`]'s value.
 935     ///
 936     /// [`Ok`]: enum.Result.html#variant.Ok
 937     /// [`Err`]: enum.Result.html#variant.Err
 938     ///
 939     /// # Examples
 940     ///
 941     /// Basic usage:
 942     ///
 943     /// ```
 944     /// let x: Result<u32, &str> = Ok(2);
 945     /// assert_eq!(x.unwrap(), 2);
 946     /// ```
 947     ///
 948     /// ```{.should_panic}
 949     /// let x: Result<u32, &str> = Err("emergency failure");
 950     /// x.unwrap(); // panics with `emergency failure`
 951     /// ```
 952     #[inline]
 953     #[stable(feature = "rust1", since = "1.0.0")]
 954     pub fn unwrap(self) -> T {
 955         match self {
 956             Ok(t) => t,
 957             Err(e) => unwrap_failed("called `Result::unwrap()` on an `Err` value", &e),
 958         }
 959     }
 960
 961     /// Unwraps a result, yielding the content of an [`Ok`].
 962     ///
 963     /// # Panics
 964     ///
 965     /// Panics if the value is an [`Err`], with a panic message including the
 966     /// passed message, and the content of the [`Err`].
 967     ///
 968     /// [`Ok`]: enum.Result.html#variant.Ok
 969     /// [`Err`]: enum.Result.html#variant.Err
 970     ///
 971     /// # Examples
 972     ///
 973     /// Basic usage:
 974     ///
 975     /// ```{.should_panic}
 976     /// let x: Result<u32, &str> = Err("emergency failure");
 977     /// x.expect("Testing expect"); // panics with `Testing expect: emergency failure`
 978     /// ```
 979     #[inline]
 980     #[stable(feature = "result_expect", since = "1.4.0")]
 981     pub fn expect(self, msg: &str) -> T {
 982         match self {
 983             Ok(t) => t,
 984             Err(e) => unwrap_failed(msg, &e),
 985         }
 986     }
 987 }
 988
 989 impl<T: fmt::Debug, E> Result<T, E> {
 990     /// Unwraps a result, yielding the content of an [`Err`].
 991     ///
 992     /// # Panics
 993     ///
 994     /// Panics if the value is an [`Ok`], with a custom panic message provided
 995     /// by the [`Ok`]'s value.
 996     ///
 997     /// [`Ok`]: enum.Result.html#variant.Ok
 998     /// [`Err`]: enum.Result.html#variant.Err
 999     ///
1000     ///
1001     /// # Examples
1002     ///
1003     /// ```{.should_panic}
1004     /// let x: Result<u32, &str> = Ok(2);
1005     /// x.unwrap_err(); // panics with `2`
1006     /// ```
1007     ///
1008     /// ```
1009     /// let x: Result<u32, &str> = Err("emergency failure");
1010     /// assert_eq!(x.unwrap_err(), "emergency failure");
1011     /// ```
1012     #[inline]
1013     #[stable(feature = "rust1", since = "1.0.0")]
1014     pub fn unwrap_err(self) -> E {
1015         match self {
1016             Ok(t) => unwrap_failed("called `Result::unwrap_err()` on an `Ok` value", &t),
1017             Err(e) => e,
1018         }
1019     }
1020
1021     /// Unwraps a result, yielding the content of an [`Err`].
1022     ///
1023     /// # Panics
1024     ///
1025     /// Panics if the value is an [`Ok`], with a panic message including the
1026     /// passed message, and the content of the [`Ok`].
1027     ///
1028     /// [`Ok`]: enum.Result.html#variant.Ok
1029     /// [`Err`]: enum.Result.html#variant.Err
1030     ///
1031     /// # Examples
1032     ///
1033     /// Basic usage:
1034     ///
1035     /// ```{.should_panic}
1036     /// let x: Result<u32, &str> = Ok(10);
1037     /// x.expect_err("Testing expect_err"); // panics with `Testing expect_err: 10`
1038     /// ```
1039     #[inline]
1040     #[stable(feature = "result_expect_err", since = "1.17.0")]
1041     pub fn expect_err(self, msg: &str) -> E {
1042         match self {
1043             Ok(t) => unwrap_failed(msg, &t),
1044             Err(e) => e,
1045         }
1046     }
1047 }
1048
1049 impl<T: Default, E> Result<T, E> {
1050     /// Returns the contained value or a default
1051     ///
1052     /// Consumes the `self` argument then, if [`Ok`], returns the contained
1053     /// value, otherwise if [`Err`], returns the default value for that
1054     /// type.
1055     ///
1056     /// # Examples
1057     ///
1058     /// Converts a string to an integer, turning poorly-formed strings
1059     /// into 0 (the default value for integers). [`parse`] converts
1060     /// a string to any other type that implements [`FromStr`], returning an
1061     /// [`Err`] on error.
1062     ///
1063     /// ```
1064     /// let good_year_from_input = "1909";
1065     /// let bad_year_from_input = "190blarg";
1066     /// let good_year = good_year_from_input.parse().unwrap_or_default();
1067     /// let bad_year = bad_year_from_input.parse().unwrap_or_default();
1068     ///
1069     /// assert_eq!(1909, good_year);
1070     /// assert_eq!(0, bad_year);
1071     /// ```
1072     ///
1073     /// [`parse`]: ../../std/primitive.str.html#method.parse
1074     /// [`FromStr`]: ../../std/str/trait.FromStr.html
1075     /// [`Ok`]: enum.Result.html#variant.Ok
1076     /// [`Err`]: enum.Result.html#variant.Err
1077     #[inline]
1078     #[stable(feature = "result_unwrap_or_default", since = "1.16.0")]
1079     pub fn unwrap_or_default(self) -> T {
1080         match self {
1081             Ok(x) => x,
1082             Err(_) => Default::default(),
1083         }
1084     }
1085 }
1086
1087 #[unstable(feature = "inner_deref", reason = "newly added", issue = "50264")]
1088 impl<T: Deref, E> Result<T, E> {
1089     /// Converts from `Result<T, E>` (or `&Result<T, E>`) to `Result<&T::Target, &E>`.
1090     ///
1091     /// Leaves the original `Result` in-place, creating a new one containing a reference to the
1092     /// `Ok` type's `Deref::Target` type.
1093     pub fn as_deref_ok(&self) -> Result<&T::Target, &E> {
1094         self.as_ref().map(|t| t.deref())
1095     }
1096 }
1097
1098 #[unstable(feature = "inner_deref", reason = "newly added", issue = "50264")]
1099 impl<T, E: Deref> Result<T, E> {
1100     /// Converts from `Result<T, E>` (or `&Result<T, E>`) to `Result<&T, &E::Target>`.
1101     ///
1102     /// Leaves the original `Result` in-place, creating a new one containing a reference to the
1103     /// `Err` type's `Deref::Target` type.
1104     pub fn as_deref_err(&self) -> Result<&T, &E::Target>
1105     {
1106         self.as_ref().map_err(|e| e.deref())
1107     }
1108 }
1109
1110 #[unstable(feature = "inner_deref", reason = "newly added", issue = "50264")]
1111 impl<T: Deref, E: Deref> Result<T, E> {
1112     /// Converts from `Result<T, E>` (or `&Result<T, E>`) to `Result<&T::Target, &E::Target>`.
1113     ///
1114     /// Leaves the original `Result` in-place, creating a new one containing a reference to both
1115     /// the `Ok` and `Err` types' `Deref::Target` types.
1116     pub fn as_deref(&self) -> Result<&T::Target, &E::Target>
1117     {
1118         self.as_ref().map(|t| t.deref()).map_err(|e| e.deref())
1119     }
1120 }
1121
1122 #[unstable(feature = "inner_deref", reason = "newly added", issue = "50264")]
1123 impl<T: DerefMut, E> Result<T, E> {
1124     /// Converts from `Result<T, E>` (or `&mut Result<T, E>`) to `Result<&mut T::Target, &mut E>`.
1125     ///
1126     /// Leaves the original `Result` in-place, creating a new one containing a mutable reference to
1127     /// the `Ok` type's `Deref::Target` type.
1128     pub fn as_deref_mut_ok(&mut self) -> Result<&mut T::Target, &mut E> {
1129         self.as_mut().map(|t| t.deref_mut())
1130     }
1131 }
1132
1133 #[unstable(feature = "inner_deref", reason = "newly added", issue = "50264")]
1134 impl<T, E: DerefMut> Result<T, E> {
1135     /// Converts from `Result<T, E>` (or `&mut Result<T, E>`) to `Result<&mut T, &mut E::Target>`.
1136     ///
1137     /// Leaves the original `Result` in-place, creating a new one containing a mutable reference to
1138     /// the `Err` type's `Deref::Target` type.
1139     pub fn as_deref_mut_err(&mut self) -> Result<&mut T, &mut E::Target>
1140     {
1141         self.as_mut().map_err(|e| e.deref_mut())
1142     }
1143 }
1144
1145 #[unstable(feature = "inner_deref", reason = "newly added", issue = "50264")]
1146 impl<T: DerefMut, E: DerefMut> Result<T, E> {
1147     /// Converts from `Result<T, E>` (or `&mut Result<T, E>`) to
1148     /// `Result<&mut T::Target, &mut E::Target>`.
1149     ///
1150     /// Leaves the original `Result` in-place, creating a new one containing a mutable reference to
1151     /// both the `Ok` and `Err` types' `Deref::Target` types.
1152     pub fn as_deref_mut(&mut self) -> Result<&mut T::Target, &mut E::Target>
1153     {
1154         self.as_mut().map(|t| t.deref_mut()).map_err(|e| e.deref_mut())
1155     }
1156 }
1157
1158 impl<T, E> Result<Option<T>, E> {
1159     /// Transposes a `Result` of an `Option` into an `Option` of a `Result`.
1160     ///
1161     /// `Ok(None)` will be mapped to `None`.
1162     /// `Ok(Some(_))` and `Err(_)` will be mapped to `Some(Ok(_))` and `Some(Err(_))`.
1163     ///
1164     /// # Examples
1165     ///
1166     /// ```
1167     /// #[derive(Debug, Eq, PartialEq)]
1168     /// struct SomeErr;
1169     ///
1170     /// let x: Result<Option<i32>, SomeErr> = Ok(Some(5));
1171     /// let y: Option<Result<i32, SomeErr>> = Some(Ok(5));
1172     /// assert_eq!(x.transpose(), y);
1173     /// ```
1174     #[inline]
1175     #[stable(feature = "transpose_result", since = "1.33.0")]
1176     pub fn transpose(self) -> Option<Result<T, E>> {
1177         match self {
1178             Ok(Some(x)) => Some(Ok(x)),
1179             Ok(None) => None,
1180             Err(e) => Some(Err(e)),
1181         }
1182     }
1183 }
1184
1185 // This is a separate function to reduce the code size of the methods
1186 #[inline(never)]
1187 #[cold]
1188 fn unwrap_failed(msg: &str, error: &dyn fmt::Debug) -> ! {
1189     panic!("{}: {:?}", msg, error)
1190 }
1191
1192 /////////////////////////////////////////////////////////////////////////////
1193 // Trait implementations
1194 /////////////////////////////////////////////////////////////////////////////
1195
1196 #[stable(feature = "rust1", since = "1.0.0")]
1197 impl<T: Clone, E: Clone> Clone for Result<T, E> {
1198     #[inline]
1199     fn clone(&self) -> Self {
1200         match self {
1201             Ok(x) => Ok(x.clone()),
1202             Err(x) => Err(x.clone()),
1203         }
1204     }
1205
1206     #[inline]
1207     fn clone_from(&mut self, source: &Self) {
1208         match (self, source) {
1209             (Ok(to), Ok(from)) => to.clone_from(from),
1210             (Err(to), Err(from)) => to.clone_from(from),
1211             (to, from) => *to = from.clone(),
1212         }
1213     }
1214 }
1215
1216
1217 #[stable(feature = "rust1", since = "1.0.0")]
1218 impl<T, E> IntoIterator for Result<T, E> {
1219     type Item = T;
1220     type IntoIter = IntoIter<T>;
1221
1222     /// Returns a consuming iterator over the possibly contained value.
1223     ///
1224     /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
1225     ///
1226     /// # Examples
1227     ///
1228     /// Basic usage:
1229     ///
1230     /// ```
1231     /// let x: Result<u32, &str> = Ok(5);
1232     /// let v: Vec<u32> = x.into_iter().collect();
1233     /// assert_eq!(v, [5]);
1234     ///
1235     /// let x: Result<u32, &str> = Err("nothing!");
1236     /// let v: Vec<u32> = x.into_iter().collect();
1237     /// assert_eq!(v, []);
1238     /// ```
1239     #[inline]
1240     fn into_iter(self) -> IntoIter<T> {
1241         IntoIter { inner: self.ok() }
1242     }
1243 }
1244
1245 #[stable(since = "1.4.0", feature = "result_iter")]
1246 impl<'a, T, E> IntoIterator for &'a Result<T, E> {
1247     type Item = &'a T;
1248     type IntoIter = Iter<'a, T>;
1249
1250     fn into_iter(self) -> Iter<'a, T> {
1251         self.iter()
1252     }
1253 }
1254
1255 #[stable(since = "1.4.0", feature = "result_iter")]
1256 impl<'a, T, E> IntoIterator for &'a mut Result<T, E> {
1257     type Item = &'a mut T;
1258     type IntoIter = IterMut<'a, T>;
1259
1260     fn into_iter(self) -> IterMut<'a, T> {
1261         self.iter_mut()
1262     }
1263 }
1264
1265 /////////////////////////////////////////////////////////////////////////////
1266 // The Result Iterators
1267 /////////////////////////////////////////////////////////////////////////////
1268
1269 /// An iterator over a reference to the [`Ok`] variant of a [`Result`].
1270 ///
1271 /// The iterator yields one value if the result is [`Ok`], otherwise none.
1272 ///
1273 /// Created by [`Result::iter`].
1274 ///
1275 /// [`Ok`]: enum.Result.html#variant.Ok
1276 /// [`Result`]: enum.Result.html
1277 /// [`Result::iter`]: enum.Result.html#method.iter
1278 #[derive(Debug)]
1279 #[stable(feature = "rust1", since = "1.0.0")]
1280 pub struct Iter<'a, T: 'a> { inner: Option<&'a T> }
1281
1282 #[stable(feature = "rust1", since = "1.0.0")]
1283 impl<'a, T> Iterator for Iter<'a, T> {
1284     type Item = &'a T;
1285
1286     #[inline]
1287     fn next(&mut self) -> Option<&'a T> { self.inner.take() }
1288     #[inline]
1289     fn size_hint(&self) -> (usize, Option<usize>) {
1290         let n = if self.inner.is_some() {1} else {0};
1291         (n, Some(n))
1292     }
1293 }
1294
1295 #[stable(feature = "rust1", since = "1.0.0")]
1296 impl<'a, T> DoubleEndedIterator for Iter<'a, T> {
1297     #[inline]
1298     fn next_back(&mut self) -> Option<&'a T> { self.inner.take() }
1299 }
1300
1301 #[stable(feature = "rust1", since = "1.0.0")]
1302 impl<T> ExactSizeIterator for Iter<'_, T> {}
1303
1304 #[stable(feature = "fused", since = "1.26.0")]
1305 impl<T> FusedIterator for Iter<'_, T> {}
1306
1307 #[unstable(feature = "trusted_len", issue = "37572")]
1308 unsafe impl<A> TrustedLen for Iter<'_, A> {}
1309
1310 #[stable(feature = "rust1", since = "1.0.0")]
1311 impl<T> Clone for Iter<'_, T> {
1312     #[inline]
1313     fn clone(&self) -> Self { Iter { inner: self.inner } }
1314 }
1315
1316 /// An iterator over a mutable reference to the [`Ok`] variant of a [`Result`].
1317 ///
1318 /// Created by [`Result::iter_mut`].
1319 ///
1320 /// [`Ok`]: enum.Result.html#variant.Ok
1321 /// [`Result`]: enum.Result.html
1322 /// [`Result::iter_mut`]: enum.Result.html#method.iter_mut
1323 #[derive(Debug)]
1324 #[stable(feature = "rust1", since = "1.0.0")]
1325 pub struct IterMut<'a, T: 'a> { inner: Option<&'a mut T> }
1326
1327 #[stable(feature = "rust1", since = "1.0.0")]
1328 impl<'a, T> Iterator for IterMut<'a, T> {
1329     type Item = &'a mut T;
1330
1331     #[inline]
1332     fn next(&mut self) -> Option<&'a mut T> { self.inner.take() }
1333     #[inline]
1334     fn size_hint(&self) -> (usize, Option<usize>) {
1335         let n = if self.inner.is_some() {1} else {0};
1336         (n, Some(n))
1337     }
1338 }
1339
1340 #[stable(feature = "rust1", since = "1.0.0")]
1341 impl<'a, T> DoubleEndedIterator for IterMut<'a, T> {
1342     #[inline]
1343     fn next_back(&mut self) -> Option<&'a mut T> { self.inner.take() }
1344 }
1345
1346 #[stable(feature = "rust1", since = "1.0.0")]
1347 impl<T> ExactSizeIterator for IterMut<'_, T> {}
1348
1349 #[stable(feature = "fused", since = "1.26.0")]
1350 impl<T> FusedIterator for IterMut<'_, T> {}
1351
1352 #[unstable(feature = "trusted_len", issue = "37572")]
1353 unsafe impl<A> TrustedLen for IterMut<'_, A> {}
1354
1355 /// An iterator over the value in a [`Ok`] variant of a [`Result`].
1356 ///
1357 /// The iterator yields one value if the result is [`Ok`], otherwise none.
1358 ///
1359 /// This struct is created by the [`into_iter`] method on
1360 /// [`Result`][`Result`] (provided by the [`IntoIterator`] trait).
1361 ///
1362 /// [`Ok`]: enum.Result.html#variant.Ok
1363 /// [`Result`]: enum.Result.html
1364 /// [`into_iter`]: ../iter/trait.IntoIterator.html#tymethod.into_iter
1365 /// [`IntoIterator`]: ../iter/trait.IntoIterator.html
1366 #[derive(Clone, Debug)]
1367 #[stable(feature = "rust1", since = "1.0.0")]
1368 pub struct IntoIter<T> { inner: Option<T> }
1369
1370 #[stable(feature = "rust1", since = "1.0.0")]
1371 impl<T> Iterator for IntoIter<T> {
1372     type Item = T;
1373
1374     #[inline]
1375     fn next(&mut self) -> Option<T> { self.inner.take() }
1376     #[inline]
1377     fn size_hint(&self) -> (usize, Option<usize>) {
1378         let n = if self.inner.is_some() {1} else {0};
1379         (n, Some(n))
1380     }
1381 }
1382
1383 #[stable(feature = "rust1", since = "1.0.0")]
1384 impl<T> DoubleEndedIterator for IntoIter<T> {
1385     #[inline]
1386     fn next_back(&mut self) -> Option<T> { self.inner.take() }
1387 }
1388
1389 #[stable(feature = "rust1", since = "1.0.0")]
1390 impl<T> ExactSizeIterator for IntoIter<T> {}
1391
1392 #[stable(feature = "fused", since = "1.26.0")]
1393 impl<T> FusedIterator for IntoIter<T> {}
1394
1395 #[unstable(feature = "trusted_len", issue = "37572")]
1396 unsafe impl<A> TrustedLen for IntoIter<A> {}
1397
1398 /////////////////////////////////////////////////////////////////////////////
1399 // FromIterator
1400 /////////////////////////////////////////////////////////////////////////////
1401
1402 #[stable(feature = "rust1", since = "1.0.0")]
1403 impl<A, E, V: FromIterator<A>> FromIterator<Result<A, E>> for Result<V, E> {
1404     /// Takes each element in the `Iterator`: if it is an `Err`, no further
1405     /// elements are taken, and the `Err` is returned. Should no `Err` occur, a
1406     /// container with the values of each `Result` is returned.
1407     ///
1408     /// Here is an example which increments every integer in a vector,
1409     /// checking for overflow:
1410     ///
1411     /// ```
1412     /// let v = vec![1, 2];
1413     /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
1414     ///     x.checked_add(1).ok_or("Overflow!")
1415     /// ).collect();
1416     /// assert_eq!(res, Ok(vec![2, 3]));
1417     /// ```
1418     ///
1419     /// Here is another example that tries to subtract one from another list
1420     /// of integers, this time checking for underflow:
1421     ///
1422     /// ```
1423     /// let v = vec![1, 2, 0];
1424     /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
1425     ///     x.checked_sub(1).ok_or("Underflow!")
1426     /// ).collect();
1427     /// assert_eq!(res, Err("Underflow!"));
1428     /// ```
1429     ///
1430     /// Here is a variation on the previous example, showing that no
1431     /// further elements are taken from `iter` after the first `Err`.
1432     ///
1433     /// ```
1434     /// let v = vec![3, 2, 1, 10];
1435     /// let mut shared = 0;
1436     /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {
1437     ///     shared += x;
1438     ///     x.checked_sub(2).ok_or("Underflow!")
1439     /// }).collect();
1440     /// assert_eq!(res, Err("Underflow!"));
1441     /// assert_eq!(shared, 6);
1442     /// ```
1443     ///
1444     /// Since the third element caused an underflow, no further elements were taken,
1445     /// so the final value of `shared` is 6 (= `3 + 2 + 1`), not 16.
1446     #[inline]
1447     fn from_iter<I: IntoIterator<Item=Result<A, E>>>(iter: I) -> Result<V, E> {
1448         // FIXME(#11084): This could be replaced with Iterator::scan when this
1449         // performance bug is closed.
1450
1451         iter::process_results(iter.into_iter(), |i| i.collect())
1452     }
1453 }
1454
1455 #[unstable(feature = "try_trait", issue = "42327")]
1456 impl<T,E> ops::Try for Result<T, E> {
1457     type Ok = T;
1458     type Error = E;
1459
1460     #[inline]
1461     fn into_result(self) -> Self {
1462         self
1463     }
1464
1465     #[inline]
1466     fn from_ok(v: T) -> Self {
1467         Ok(v)
1468     }
1469
1470     #[inline]
1471     fn from_error(v: E) -> Self {
1472         Err(v)
1473     }
1474 }