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     /// Maps a `Result<T, E>` to `U` by applying a function to a
 518     /// contained [`Ok`] value, or a fallback function to a
 519     /// contained [`Err`] value.
 520     ///
 521     /// This function can be used to unpack a successful result
 522     /// while handling an error.
 523     ///
 524     /// [`Ok`]: enum.Result.html#variant.Ok
 525     /// [`Err`]: enum.Result.html#variant.Err
 526     ///
 527     /// # Examples
 528     ///
 529     /// Basic usage:
 530     ///
 531     /// ```
 532     /// #![feature(result_map_or_else)]
 533     /// let k = 21;
 534     ///
 535     /// let x : Result<_, &str> = Ok("foo");
 536     /// assert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);
 537     ///
 538     /// let x : Result<&str, _> = Err("bar");
 539     /// assert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
 540     /// ```
 541     #[inline]
 542     #[unstable(feature = "result_map_or_else", issue = "53268")]
 543     pub fn map_or_else<U, M: FnOnce(T) -> U, F: FnOnce(E) -> U>(self, fallback: F, map: M) -> U {
 544         self.map(map).unwrap_or_else(fallback)
 545     }
 546
 547     /// Maps a `Result<T, E>` to `Result<T, F>` by applying a function to a
 548     /// contained [`Err`] value, leaving an [`Ok`] value untouched.
 549     ///
 550     /// This function can be used to pass through a successful result while handling
 551     /// an error.
 552     ///
 553     /// [`Ok`]: enum.Result.html#variant.Ok
 554     /// [`Err`]: enum.Result.html#variant.Err
 555     ///
 556     /// # Examples
 557     ///
 558     /// Basic usage:
 559     ///
 560     /// ```
 561     /// fn stringify(x: u32) -> String { format!("error code: {}", x) }
 562     ///
 563     /// let x: Result<u32, u32> = Ok(2);
 564     /// assert_eq!(x.map_err(stringify), Ok(2));
 565     ///
 566     /// let x: Result<u32, u32> = Err(13);
 567     /// assert_eq!(x.map_err(stringify), Err("error code: 13".to_string()));
 568     /// ```
 569     #[inline]
 570     #[stable(feature = "rust1", since = "1.0.0")]
 571     pub fn map_err<F, O: FnOnce(E) -> F>(self, op: O) -> Result<T,F> {
 572         match self {
 573             Ok(t) => Ok(t),
 574             Err(e) => Err(op(e))
 575         }
 576     }
 577
 578     /////////////////////////////////////////////////////////////////////////
 579     // Iterator constructors
 580     /////////////////////////////////////////////////////////////////////////
 581
 582     /// Returns an iterator over the possibly contained value.
 583     ///
 584     /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
 585     ///
 586     /// # Examples
 587     ///
 588     /// Basic usage:
 589     ///
 590     /// ```
 591     /// let x: Result<u32, &str> = Ok(7);
 592     /// assert_eq!(x.iter().next(), Some(&7));
 593     ///
 594     /// let x: Result<u32, &str> = Err("nothing!");
 595     /// assert_eq!(x.iter().next(), None);
 596     /// ```
 597     #[inline]
 598     #[stable(feature = "rust1", since = "1.0.0")]
 599     pub fn iter(&self) -> Iter<'_, T> {
 600         Iter { inner: self.as_ref().ok() }
 601     }
 602
 603     /// Returns a mutable iterator over the possibly contained value.
 604     ///
 605     /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
 606     ///
 607     /// # Examples
 608     ///
 609     /// Basic usage:
 610     ///
 611     /// ```
 612     /// let mut x: Result<u32, &str> = Ok(7);
 613     /// match x.iter_mut().next() {
 614     ///     Some(v) => *v = 40,
 615     ///     None => {},
 616     /// }
 617     /// assert_eq!(x, Ok(40));
 618     ///
 619     /// let mut x: Result<u32, &str> = Err("nothing!");
 620     /// assert_eq!(x.iter_mut().next(), None);
 621     /// ```
 622     #[inline]
 623     #[stable(feature = "rust1", since = "1.0.0")]
 624     pub fn iter_mut(&mut self) -> IterMut<'_, T> {
 625         IterMut { inner: self.as_mut().ok() }
 626     }
 627
 628     ////////////////////////////////////////////////////////////////////////
 629     // Boolean operations on the values, eager and lazy
 630     /////////////////////////////////////////////////////////////////////////
 631
 632     /// Returns `res` if the result is [`Ok`], otherwise returns the [`Err`] value of `self`.
 633     ///
 634     /// [`Ok`]: enum.Result.html#variant.Ok
 635     /// [`Err`]: enum.Result.html#variant.Err
 636     ///
 637     /// # Examples
 638     ///
 639     /// Basic usage:
 640     ///
 641     /// ```
 642     /// let x: Result<u32, &str> = Ok(2);
 643     /// let y: Result<&str, &str> = Err("late error");
 644     /// assert_eq!(x.and(y), Err("late error"));
 645     ///
 646     /// let x: Result<u32, &str> = Err("early error");
 647     /// let y: Result<&str, &str> = Ok("foo");
 648     /// assert_eq!(x.and(y), Err("early error"));
 649     ///
 650     /// let x: Result<u32, &str> = Err("not a 2");
 651     /// let y: Result<&str, &str> = Err("late error");
 652     /// assert_eq!(x.and(y), Err("not a 2"));
 653     ///
 654     /// let x: Result<u32, &str> = Ok(2);
 655     /// let y: Result<&str, &str> = Ok("different result type");
 656     /// assert_eq!(x.and(y), Ok("different result type"));
 657     /// ```
 658     #[inline]
 659     #[stable(feature = "rust1", since = "1.0.0")]
 660     pub fn and<U>(self, res: Result<U, E>) -> Result<U, E> {
 661         match self {
 662             Ok(_) => res,
 663             Err(e) => Err(e),
 664         }
 665     }
 666
 667     /// Calls `op` if the result is [`Ok`], otherwise returns the [`Err`] value of `self`.
 668     ///
 669     /// [`Ok`]: enum.Result.html#variant.Ok
 670     /// [`Err`]: enum.Result.html#variant.Err
 671     ///
 672     /// This function can be used for control flow based on `Result` values.
 673     ///
 674     /// # Examples
 675     ///
 676     /// Basic usage:
 677     ///
 678     /// ```
 679     /// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
 680     /// fn err(x: u32) -> Result<u32, u32> { Err(x) }
 681     ///
 682     /// assert_eq!(Ok(2).and_then(sq).and_then(sq), Ok(16));
 683     /// assert_eq!(Ok(2).and_then(sq).and_then(err), Err(4));
 684     /// assert_eq!(Ok(2).and_then(err).and_then(sq), Err(2));
 685     /// assert_eq!(Err(3).and_then(sq).and_then(sq), Err(3));
 686     /// ```
 687     #[inline]
 688     #[stable(feature = "rust1", since = "1.0.0")]
 689     pub fn and_then<U, F: FnOnce(T) -> Result<U, E>>(self, op: F) -> Result<U, E> {
 690         match self {
 691             Ok(t) => op(t),
 692             Err(e) => Err(e),
 693         }
 694     }
 695
 696     /// Returns `res` if the result is [`Err`], otherwise returns the [`Ok`] value of `self`.
 697     ///
 698     /// Arguments passed to `or` are eagerly evaluated; if you are passing the
 699     /// result of a function call, it is recommended to use [`or_else`], which is
 700     /// lazily evaluated.
 701     ///
 702     /// [`Ok`]: enum.Result.html#variant.Ok
 703     /// [`Err`]: enum.Result.html#variant.Err
 704     /// [`or_else`]: #method.or_else
 705     ///
 706     /// # Examples
 707     ///
 708     /// Basic usage:
 709     ///
 710     /// ```
 711     /// let x: Result<u32, &str> = Ok(2);
 712     /// let y: Result<u32, &str> = Err("late error");
 713     /// assert_eq!(x.or(y), Ok(2));
 714     ///
 715     /// let x: Result<u32, &str> = Err("early error");
 716     /// let y: Result<u32, &str> = Ok(2);
 717     /// assert_eq!(x.or(y), Ok(2));
 718     ///
 719     /// let x: Result<u32, &str> = Err("not a 2");
 720     /// let y: Result<u32, &str> = Err("late error");
 721     /// assert_eq!(x.or(y), Err("late error"));
 722     ///
 723     /// let x: Result<u32, &str> = Ok(2);
 724     /// let y: Result<u32, &str> = Ok(100);
 725     /// assert_eq!(x.or(y), Ok(2));
 726     /// ```
 727     #[inline]
 728     #[stable(feature = "rust1", since = "1.0.0")]
 729     pub fn or<F>(self, res: Result<T, F>) -> Result<T, F> {
 730         match self {
 731             Ok(v) => Ok(v),
 732             Err(_) => res,
 733         }
 734     }
 735
 736     /// Calls `op` if the result is [`Err`], otherwise returns the [`Ok`] value of `self`.
 737     ///
 738     /// This function can be used for control flow based on result values.
 739     ///
 740     /// [`Ok`]: enum.Result.html#variant.Ok
 741     /// [`Err`]: enum.Result.html#variant.Err
 742     ///
 743     /// # Examples
 744     ///
 745     /// Basic usage:
 746     ///
 747     /// ```
 748     /// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
 749     /// fn err(x: u32) -> Result<u32, u32> { Err(x) }
 750     ///
 751     /// assert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));
 752     /// assert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));
 753     /// assert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));
 754     /// assert_eq!(Err(3).or_else(err).or_else(err), Err(3));
 755     /// ```
 756     #[inline]
 757     #[stable(feature = "rust1", since = "1.0.0")]
 758     pub fn or_else<F, O: FnOnce(E) -> Result<T, F>>(self, op: O) -> Result<T, F> {
 759         match self {
 760             Ok(t) => Ok(t),
 761             Err(e) => op(e),
 762         }
 763     }
 764
 765     /// Unwraps a result, yielding the content of an [`Ok`].
 766     /// Else, it returns `optb`.
 767     ///
 768     /// Arguments passed to `unwrap_or` are eagerly evaluated; if you are passing
 769     /// the result of a function call, it is recommended to use [`unwrap_or_else`],
 770     /// which is lazily evaluated.
 771     ///
 772     /// [`Ok`]: enum.Result.html#variant.Ok
 773     /// [`Err`]: enum.Result.html#variant.Err
 774     /// [`unwrap_or_else`]: #method.unwrap_or_else
 775     ///
 776     /// # Examples
 777     ///
 778     /// Basic usage:
 779     ///
 780     /// ```
 781     /// let optb = 2;
 782     /// let x: Result<u32, &str> = Ok(9);
 783     /// assert_eq!(x.unwrap_or(optb), 9);
 784     ///
 785     /// let x: Result<u32, &str> = Err("error");
 786     /// assert_eq!(x.unwrap_or(optb), optb);
 787     /// ```
 788     #[inline]
 789     #[stable(feature = "rust1", since = "1.0.0")]
 790     pub fn unwrap_or(self, optb: T) -> T {
 791         match self {
 792             Ok(t) => t,
 793             Err(_) => optb
 794         }
 795     }
 796
 797     /// Unwraps a result, yielding the content of an [`Ok`].
 798     /// If the value is an [`Err`] then it calls `op` with its value.
 799     ///
 800     /// [`Ok`]: enum.Result.html#variant.Ok
 801     /// [`Err`]: enum.Result.html#variant.Err
 802     ///
 803     /// # Examples
 804     ///
 805     /// Basic usage:
 806     ///
 807     /// ```
 808     /// fn count(x: &str) -> usize { x.len() }
 809     ///
 810     /// assert_eq!(Ok(2).unwrap_or_else(count), 2);
 811     /// assert_eq!(Err("foo").unwrap_or_else(count), 3);
 812     /// ```
 813     #[inline]
 814     #[stable(feature = "rust1", since = "1.0.0")]
 815     pub fn unwrap_or_else<F: FnOnce(E) -> T>(self, op: F) -> T {
 816         match self {
 817             Ok(t) => t,
 818             Err(e) => op(e)
 819         }
 820     }
 821 }
 822
 823 impl<T: Copy, E> Result<&T, E> {
 824     /// Maps a `Result<&T, E>` to a `Result<T, E>` by copying the contents of the
 825     /// `Ok` part.
 826     ///
 827     /// # Examples
 828     ///
 829     /// ```
 830     /// #![feature(result_copied)]
 831     /// let val = 12;
 832     /// let x: Result<&i32, i32> = Ok(&val);
 833     /// assert_eq!(x, Ok(&12));
 834     /// let copied = x.copied();
 835     /// assert_eq!(copied, Ok(12));
 836     /// ```
 837     #[unstable(feature = "result_copied", reason = "newly added", issue = "63168")]
 838     pub fn copied(self) -> Result<T, E> {
 839         self.map(|&t| t)
 840     }
 841 }
 842
 843 impl<T: Copy, E> Result<&mut T, E> {
 844     /// Maps a `Result<&mut T, E>` to a `Result<T, E>` by copying the contents of the
 845     /// `Ok` part.
 846     ///
 847     /// # Examples
 848     ///
 849     /// ```
 850     /// #![feature(result_copied)]
 851     /// let mut val = 12;
 852     /// let x: Result<&mut i32, i32> = Ok(&mut val);
 853     /// assert_eq!(x, Ok(&mut 12));
 854     /// let copied = x.copied();
 855     /// assert_eq!(copied, Ok(12));
 856     /// ```
 857     #[unstable(feature = "result_copied", reason = "newly added", issue = "63168")]
 858     pub fn copied(self) -> Result<T, E> {
 859         self.map(|&mut t| t)
 860     }
 861 }
 862
 863 impl<T: Clone, E> Result<&T, E> {
 864     /// Maps a `Result<&T, E>` to a `Result<T, E>` by cloning the contents of the
 865     /// `Ok` part.
 866     ///
 867     /// # Examples
 868     ///
 869     /// ```
 870     /// #![feature(result_cloned)]
 871     /// let val = 12;
 872     /// let x: Result<&i32, i32> = Ok(&val);
 873     /// assert_eq!(x, Ok(&12));
 874     /// let cloned = x.cloned();
 875     /// assert_eq!(cloned, Ok(12));
 876     /// ```
 877     #[unstable(feature = "result_cloned", reason = "newly added", issue = "63168")]
 878     pub fn cloned(self) -> Result<T, E> {
 879         self.map(|t| t.clone())
 880     }
 881 }
 882
 883 impl<T: Clone, E> Result<&mut T, E> {
 884     /// Maps a `Result<&mut T, E>` to a `Result<T, E>` by cloning the contents of the
 885     /// `Ok` part.
 886     ///
 887     /// # Examples
 888     ///
 889     /// ```
 890     /// #![feature(result_cloned)]
 891     /// let mut val = 12;
 892     /// let x: Result<&mut i32, i32> = Ok(&mut val);
 893     /// assert_eq!(x, Ok(&mut 12));
 894     /// let cloned = x.cloned();
 895     /// assert_eq!(cloned, Ok(12));
 896     /// ```
 897     #[unstable(feature = "result_cloned", reason = "newly added", issue = "63168")]
 898     pub fn cloned(self) -> Result<T, E> {
 899         self.map(|t| t.clone())
 900     }
 901 }
 902
 903
 904 impl<T, E: fmt::Debug> Result<T, E> {
 905     /// Unwraps a result, yielding the content of an [`Ok`].
 906     ///
 907     /// # Panics
 908     ///
 909     /// Panics if the value is an [`Err`], with a panic message provided by the
 910     /// [`Err`]'s value.
 911     ///
 912     /// [`Ok`]: enum.Result.html#variant.Ok
 913     /// [`Err`]: enum.Result.html#variant.Err
 914     ///
 915     /// # Examples
 916     ///
 917     /// Basic usage:
 918     ///
 919     /// ```
 920     /// let x: Result<u32, &str> = Ok(2);
 921     /// assert_eq!(x.unwrap(), 2);
 922     /// ```
 923     ///
 924     /// ```{.should_panic}
 925     /// let x: Result<u32, &str> = Err("emergency failure");
 926     /// x.unwrap(); // panics with `emergency failure`
 927     /// ```
 928     #[inline]
 929     #[stable(feature = "rust1", since = "1.0.0")]
 930     pub fn unwrap(self) -> T {
 931         match self {
 932             Ok(t) => t,
 933             Err(e) => unwrap_failed("called `Result::unwrap()` on an `Err` value", &e),
 934         }
 935     }
 936
 937     /// Unwraps a result, yielding the content of an [`Ok`].
 938     ///
 939     /// # Panics
 940     ///
 941     /// Panics if the value is an [`Err`], with a panic message including the
 942     /// passed message, and the content of the [`Err`].
 943     ///
 944     /// [`Ok`]: enum.Result.html#variant.Ok
 945     /// [`Err`]: enum.Result.html#variant.Err
 946     ///
 947     /// # Examples
 948     ///
 949     /// Basic usage:
 950     ///
 951     /// ```{.should_panic}
 952     /// let x: Result<u32, &str> = Err("emergency failure");
 953     /// x.expect("Testing expect"); // panics with `Testing expect: emergency failure`
 954     /// ```
 955     #[inline]
 956     #[stable(feature = "result_expect", since = "1.4.0")]
 957     pub fn expect(self, msg: &str) -> T {
 958         match self {
 959             Ok(t) => t,
 960             Err(e) => unwrap_failed(msg, &e),
 961         }
 962     }
 963 }
 964
 965 impl<T: fmt::Debug, E> Result<T, E> {
 966     /// Unwraps a result, yielding the content of an [`Err`].
 967     ///
 968     /// # Panics
 969     ///
 970     /// Panics if the value is an [`Ok`], with a custom panic message provided
 971     /// by the [`Ok`]'s value.
 972     ///
 973     /// [`Ok`]: enum.Result.html#variant.Ok
 974     /// [`Err`]: enum.Result.html#variant.Err
 975     ///
 976     ///
 977     /// # Examples
 978     ///
 979     /// ```{.should_panic}
 980     /// let x: Result<u32, &str> = Ok(2);
 981     /// x.unwrap_err(); // panics with `2`
 982     /// ```
 983     ///
 984     /// ```
 985     /// let x: Result<u32, &str> = Err("emergency failure");
 986     /// assert_eq!(x.unwrap_err(), "emergency failure");
 987     /// ```
 988     #[inline]
 989     #[stable(feature = "rust1", since = "1.0.0")]
 990     pub fn unwrap_err(self) -> E {
 991         match self {
 992             Ok(t) => unwrap_failed("called `Result::unwrap_err()` on an `Ok` value", &t),
 993             Err(e) => e,
 994         }
 995     }
 996
 997     /// Unwraps a result, yielding the content of an [`Err`].
 998     ///
 999     /// # Panics
1000     ///
1001     /// Panics if the value is an [`Ok`], with a panic message including the
1002     /// passed message, and the content of the [`Ok`].
1003     ///
1004     /// [`Ok`]: enum.Result.html#variant.Ok
1005     /// [`Err`]: enum.Result.html#variant.Err
1006     ///
1007     /// # Examples
1008     ///
1009     /// Basic usage:
1010     ///
1011     /// ```{.should_panic}
1012     /// let x: Result<u32, &str> = Ok(10);
1013     /// x.expect_err("Testing expect_err"); // panics with `Testing expect_err: 10`
1014     /// ```
1015     #[inline]
1016     #[stable(feature = "result_expect_err", since = "1.17.0")]
1017     pub fn expect_err(self, msg: &str) -> E {
1018         match self {
1019             Ok(t) => unwrap_failed(msg, &t),
1020             Err(e) => e,
1021         }
1022     }
1023 }
1024
1025 impl<T: Default, E> Result<T, E> {
1026     /// Returns the contained value or a default
1027     ///
1028     /// Consumes the `self` argument then, if [`Ok`], returns the contained
1029     /// value, otherwise if [`Err`], returns the default value for that
1030     /// type.
1031     ///
1032     /// # Examples
1033     ///
1034     /// Converts a string to an integer, turning poorly-formed strings
1035     /// into 0 (the default value for integers). [`parse`] converts
1036     /// a string to any other type that implements [`FromStr`], returning an
1037     /// [`Err`] on error.
1038     ///
1039     /// ```
1040     /// let good_year_from_input = "1909";
1041     /// let bad_year_from_input = "190blarg";
1042     /// let good_year = good_year_from_input.parse().unwrap_or_default();
1043     /// let bad_year = bad_year_from_input.parse().unwrap_or_default();
1044     ///
1045     /// assert_eq!(1909, good_year);
1046     /// assert_eq!(0, bad_year);
1047     /// ```
1048     ///
1049     /// [`parse`]: ../../std/primitive.str.html#method.parse
1050     /// [`FromStr`]: ../../std/str/trait.FromStr.html
1051     /// [`Ok`]: enum.Result.html#variant.Ok
1052     /// [`Err`]: enum.Result.html#variant.Err
1053     #[inline]
1054     #[stable(feature = "result_unwrap_or_default", since = "1.16.0")]
1055     pub fn unwrap_or_default(self) -> T {
1056         match self {
1057             Ok(x) => x,
1058             Err(_) => Default::default(),
1059         }
1060     }
1061 }
1062
1063 #[unstable(feature = "inner_deref", reason = "newly added", issue = "50264")]
1064 impl<T: Deref, E> Result<T, E> {
1065     /// Converts from `Result<T, E>` (or `&Result<T, E>`) to `Result<&T::Target, &E>`.
1066     ///
1067     /// Leaves the original `Result` in-place, creating a new one containing a reference to the
1068     /// `Ok` type's `Deref::Target` type.
1069     pub fn as_deref_ok(&self) -> Result<&T::Target, &E> {
1070         self.as_ref().map(|t| t.deref())
1071     }
1072 }
1073
1074 #[unstable(feature = "inner_deref", reason = "newly added", issue = "50264")]
1075 impl<T, E: Deref> Result<T, E> {
1076     /// Converts from `Result<T, E>` (or `&Result<T, E>`) to `Result<&T, &E::Target>`.
1077     ///
1078     /// Leaves the original `Result` in-place, creating a new one containing a reference to the
1079     /// `Err` type's `Deref::Target` type.
1080     pub fn as_deref_err(&self) -> Result<&T, &E::Target>
1081     {
1082         self.as_ref().map_err(|e| e.deref())
1083     }
1084 }
1085
1086 #[unstable(feature = "inner_deref", reason = "newly added", issue = "50264")]
1087 impl<T: Deref, E: Deref> Result<T, E> {
1088     /// Converts from `Result<T, E>` (or `&Result<T, E>`) to `Result<&T::Target, &E::Target>`.
1089     ///
1090     /// Leaves the original `Result` in-place, creating a new one containing a reference to both
1091     /// the `Ok` and `Err` types' `Deref::Target` types.
1092     pub fn as_deref(&self) -> Result<&T::Target, &E::Target>
1093     {
1094         self.as_ref().map(|t| t.deref()).map_err(|e| e.deref())
1095     }
1096 }
1097
1098 #[unstable(feature = "inner_deref", reason = "newly added", issue = "50264")]
1099 impl<T: DerefMut, E> Result<T, E> {
1100     /// Converts from `Result<T, E>` (or `&mut Result<T, E>`) to `Result<&mut T::Target, &mut E>`.
1101     ///
1102     /// Leaves the original `Result` in-place, creating a new one containing a mutable reference to
1103     /// the `Ok` type's `Deref::Target` type.
1104     pub fn as_deref_mut_ok(&mut self) -> Result<&mut T::Target, &mut E> {
1105         self.as_mut().map(|t| t.deref_mut())
1106     }
1107 }
1108
1109 #[unstable(feature = "inner_deref", reason = "newly added", issue = "50264")]
1110 impl<T, E: DerefMut> Result<T, E> {
1111     /// Converts from `Result<T, E>` (or `&mut Result<T, E>`) to `Result<&mut T, &mut E::Target>`.
1112     ///
1113     /// Leaves the original `Result` in-place, creating a new one containing a mutable reference to
1114     /// the `Err` type's `Deref::Target` type.
1115     pub fn as_deref_mut_err(&mut self) -> Result<&mut T, &mut E::Target>
1116     {
1117         self.as_mut().map_err(|e| e.deref_mut())
1118     }
1119 }
1120
1121 #[unstable(feature = "inner_deref", reason = "newly added", issue = "50264")]
1122 impl<T: DerefMut, E: DerefMut> Result<T, E> {
1123     /// Converts from `Result<T, E>` (or `&mut Result<T, E>`) to
1124     /// `Result<&mut T::Target, &mut E::Target>`.
1125     ///
1126     /// Leaves the original `Result` in-place, creating a new one containing a mutable reference to
1127     /// both the `Ok` and `Err` types' `Deref::Target` types.
1128     pub fn as_deref_mut(&mut self) -> Result<&mut T::Target, &mut E::Target>
1129     {
1130         self.as_mut().map(|t| t.deref_mut()).map_err(|e| e.deref_mut())
1131     }
1132 }
1133
1134 impl<T, E> Result<Option<T>, E> {
1135     /// Transposes a `Result` of an `Option` into an `Option` of a `Result`.
1136     ///
1137     /// `Ok(None)` will be mapped to `None`.
1138     /// `Ok(Some(_))` and `Err(_)` will be mapped to `Some(Ok(_))` and `Some(Err(_))`.
1139     ///
1140     /// # Examples
1141     ///
1142     /// ```
1143     /// #[derive(Debug, Eq, PartialEq)]
1144     /// struct SomeErr;
1145     ///
1146     /// let x: Result<Option<i32>, SomeErr> = Ok(Some(5));
1147     /// let y: Option<Result<i32, SomeErr>> = Some(Ok(5));
1148     /// assert_eq!(x.transpose(), y);
1149     /// ```
1150     #[inline]
1151     #[stable(feature = "transpose_result", since = "1.33.0")]
1152     pub fn transpose(self) -> Option<Result<T, E>> {
1153         match self {
1154             Ok(Some(x)) => Some(Ok(x)),
1155             Ok(None) => None,
1156             Err(e) => Some(Err(e)),
1157         }
1158     }
1159 }
1160
1161 // This is a separate function to reduce the code size of the methods
1162 #[inline(never)]
1163 #[cold]
1164 fn unwrap_failed(msg: &str, error: &dyn fmt::Debug) -> ! {
1165     panic!("{}: {:?}", msg, error)
1166 }
1167
1168 /////////////////////////////////////////////////////////////////////////////
1169 // Trait implementations
1170 /////////////////////////////////////////////////////////////////////////////
1171
1172 #[stable(feature = "rust1", since = "1.0.0")]
1173 impl<T: Clone, E: Clone> Clone for Result<T, E> {
1174     #[inline]
1175     fn clone(&self) -> Self {
1176         match self {
1177             Ok(x) => Ok(x.clone()),
1178             Err(x) => Err(x.clone()),
1179         }
1180     }
1181
1182     #[inline]
1183     fn clone_from(&mut self, source: &Self) {
1184         match (self, source) {
1185             (Ok(to), Ok(from)) => to.clone_from(from),
1186             (Err(to), Err(from)) => to.clone_from(from),
1187             (to, from) => *to = from.clone(),
1188         }
1189     }
1190 }
1191
1192
1193 #[stable(feature = "rust1", since = "1.0.0")]
1194 impl<T, E> IntoIterator for Result<T, E> {
1195     type Item = T;
1196     type IntoIter = IntoIter<T>;
1197
1198     /// Returns a consuming iterator over the possibly contained value.
1199     ///
1200     /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
1201     ///
1202     /// # Examples
1203     ///
1204     /// Basic usage:
1205     ///
1206     /// ```
1207     /// let x: Result<u32, &str> = Ok(5);
1208     /// let v: Vec<u32> = x.into_iter().collect();
1209     /// assert_eq!(v, [5]);
1210     ///
1211     /// let x: Result<u32, &str> = Err("nothing!");
1212     /// let v: Vec<u32> = x.into_iter().collect();
1213     /// assert_eq!(v, []);
1214     /// ```
1215     #[inline]
1216     fn into_iter(self) -> IntoIter<T> {
1217         IntoIter { inner: self.ok() }
1218     }
1219 }
1220
1221 #[stable(since = "1.4.0", feature = "result_iter")]
1222 impl<'a, T, E> IntoIterator for &'a Result<T, E> {
1223     type Item = &'a T;
1224     type IntoIter = Iter<'a, T>;
1225
1226     fn into_iter(self) -> Iter<'a, T> {
1227         self.iter()
1228     }
1229 }
1230
1231 #[stable(since = "1.4.0", feature = "result_iter")]
1232 impl<'a, T, E> IntoIterator for &'a mut Result<T, E> {
1233     type Item = &'a mut T;
1234     type IntoIter = IterMut<'a, T>;
1235
1236     fn into_iter(self) -> IterMut<'a, T> {
1237         self.iter_mut()
1238     }
1239 }
1240
1241 /////////////////////////////////////////////////////////////////////////////
1242 // The Result Iterators
1243 /////////////////////////////////////////////////////////////////////////////
1244
1245 /// An iterator over a reference to the [`Ok`] variant of a [`Result`].
1246 ///
1247 /// The iterator yields one value if the result is [`Ok`], otherwise none.
1248 ///
1249 /// Created by [`Result::iter`].
1250 ///
1251 /// [`Ok`]: enum.Result.html#variant.Ok
1252 /// [`Result`]: enum.Result.html
1253 /// [`Result::iter`]: enum.Result.html#method.iter
1254 #[derive(Debug)]
1255 #[stable(feature = "rust1", since = "1.0.0")]
1256 pub struct Iter<'a, T: 'a> { inner: Option<&'a T> }
1257
1258 #[stable(feature = "rust1", since = "1.0.0")]
1259 impl<'a, T> Iterator for Iter<'a, T> {
1260     type Item = &'a T;
1261
1262     #[inline]
1263     fn next(&mut self) -> Option<&'a T> { self.inner.take() }
1264     #[inline]
1265     fn size_hint(&self) -> (usize, Option<usize>) {
1266         let n = if self.inner.is_some() {1} else {0};
1267         (n, Some(n))
1268     }
1269 }
1270
1271 #[stable(feature = "rust1", since = "1.0.0")]
1272 impl<'a, T> DoubleEndedIterator for Iter<'a, T> {
1273     #[inline]
1274     fn next_back(&mut self) -> Option<&'a T> { self.inner.take() }
1275 }
1276
1277 #[stable(feature = "rust1", since = "1.0.0")]
1278 impl<T> ExactSizeIterator for Iter<'_, T> {}
1279
1280 #[stable(feature = "fused", since = "1.26.0")]
1281 impl<T> FusedIterator for Iter<'_, T> {}
1282
1283 #[unstable(feature = "trusted_len", issue = "37572")]
1284 unsafe impl<A> TrustedLen for Iter<'_, A> {}
1285
1286 #[stable(feature = "rust1", since = "1.0.0")]
1287 impl<T> Clone for Iter<'_, T> {
1288     #[inline]
1289     fn clone(&self) -> Self { Iter { inner: self.inner } }
1290 }
1291
1292 /// An iterator over a mutable reference to the [`Ok`] variant of a [`Result`].
1293 ///
1294 /// Created by [`Result::iter_mut`].
1295 ///
1296 /// [`Ok`]: enum.Result.html#variant.Ok
1297 /// [`Result`]: enum.Result.html
1298 /// [`Result::iter_mut`]: enum.Result.html#method.iter_mut
1299 #[derive(Debug)]
1300 #[stable(feature = "rust1", since = "1.0.0")]
1301 pub struct IterMut<'a, T: 'a> { inner: Option<&'a mut T> }
1302
1303 #[stable(feature = "rust1", since = "1.0.0")]
1304 impl<'a, T> Iterator for IterMut<'a, T> {
1305     type Item = &'a mut T;
1306
1307     #[inline]
1308     fn next(&mut self) -> Option<&'a mut T> { self.inner.take() }
1309     #[inline]
1310     fn size_hint(&self) -> (usize, Option<usize>) {
1311         let n = if self.inner.is_some() {1} else {0};
1312         (n, Some(n))
1313     }
1314 }
1315
1316 #[stable(feature = "rust1", since = "1.0.0")]
1317 impl<'a, T> DoubleEndedIterator for IterMut<'a, T> {
1318     #[inline]
1319     fn next_back(&mut self) -> Option<&'a mut T> { self.inner.take() }
1320 }
1321
1322 #[stable(feature = "rust1", since = "1.0.0")]
1323 impl<T> ExactSizeIterator for IterMut<'_, T> {}
1324
1325 #[stable(feature = "fused", since = "1.26.0")]
1326 impl<T> FusedIterator for IterMut<'_, T> {}
1327
1328 #[unstable(feature = "trusted_len", issue = "37572")]
1329 unsafe impl<A> TrustedLen for IterMut<'_, A> {}
1330
1331 /// An iterator over the value in a [`Ok`] variant of a [`Result`].
1332 ///
1333 /// The iterator yields one value if the result is [`Ok`], otherwise none.
1334 ///
1335 /// This struct is created by the [`into_iter`] method on
1336 /// [`Result`][`Result`] (provided by the [`IntoIterator`] trait).
1337 ///
1338 /// [`Ok`]: enum.Result.html#variant.Ok
1339 /// [`Result`]: enum.Result.html
1340 /// [`into_iter`]: ../iter/trait.IntoIterator.html#tymethod.into_iter
1341 /// [`IntoIterator`]: ../iter/trait.IntoIterator.html
1342 #[derive(Clone, Debug)]
1343 #[stable(feature = "rust1", since = "1.0.0")]
1344 pub struct IntoIter<T> { inner: Option<T> }
1345
1346 #[stable(feature = "rust1", since = "1.0.0")]
1347 impl<T> Iterator for IntoIter<T> {
1348     type Item = T;
1349
1350     #[inline]
1351     fn next(&mut self) -> Option<T> { self.inner.take() }
1352     #[inline]
1353     fn size_hint(&self) -> (usize, Option<usize>) {
1354         let n = if self.inner.is_some() {1} else {0};
1355         (n, Some(n))
1356     }
1357 }
1358
1359 #[stable(feature = "rust1", since = "1.0.0")]
1360 impl<T> DoubleEndedIterator for IntoIter<T> {
1361     #[inline]
1362     fn next_back(&mut self) -> Option<T> { self.inner.take() }
1363 }
1364
1365 #[stable(feature = "rust1", since = "1.0.0")]
1366 impl<T> ExactSizeIterator for IntoIter<T> {}
1367
1368 #[stable(feature = "fused", since = "1.26.0")]
1369 impl<T> FusedIterator for IntoIter<T> {}
1370
1371 #[unstable(feature = "trusted_len", issue = "37572")]
1372 unsafe impl<A> TrustedLen for IntoIter<A> {}
1373
1374 /////////////////////////////////////////////////////////////////////////////
1375 // FromIterator
1376 /////////////////////////////////////////////////////////////////////////////
1377
1378 #[stable(feature = "rust1", since = "1.0.0")]
1379 impl<A, E, V: FromIterator<A>> FromIterator<Result<A, E>> for Result<V, E> {
1380     /// Takes each element in the `Iterator`: if it is an `Err`, no further
1381     /// elements are taken, and the `Err` is returned. Should no `Err` occur, a
1382     /// container with the values of each `Result` is returned.
1383     ///
1384     /// Here is an example which increments every integer in a vector,
1385     /// checking for overflow:
1386     ///
1387     /// ```
1388     /// let v = vec![1, 2];
1389     /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
1390     ///     x.checked_add(1).ok_or("Overflow!")
1391     /// ).collect();
1392     /// assert_eq!(res, Ok(vec![2, 3]));
1393     /// ```
1394     ///
1395     /// Here is another example that tries to subtract one from another list
1396     /// of integers, this time checking for underflow:
1397     ///
1398     /// ```
1399     /// let v = vec![1, 2, 0];
1400     /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
1401     ///     x.checked_sub(1).ok_or("Underflow!")
1402     /// ).collect();
1403     /// assert_eq!(res, Err("Underflow!"));
1404     /// ```
1405     ///
1406     /// Here is a variation on the previous example, showing that no
1407     /// further elements are taken from `iter` after the first `Err`.
1408     ///
1409     /// ```
1410     /// let v = vec![3, 2, 1, 10];
1411     /// let mut shared = 0;
1412     /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {
1413     ///     shared += x;
1414     ///     x.checked_sub(2).ok_or("Underflow!")
1415     /// }).collect();
1416     /// assert_eq!(res, Err("Underflow!"));
1417     /// assert_eq!(shared, 6);
1418     /// ```
1419     ///
1420     /// Since the third element caused an underflow, no further elements were taken,
1421     /// so the final value of `shared` is 6 (= `3 + 2 + 1`), not 16.
1422     #[inline]
1423     fn from_iter<I: IntoIterator<Item=Result<A, E>>>(iter: I) -> Result<V, E> {
1424         // FIXME(#11084): This could be replaced with Iterator::scan when this
1425         // performance bug is closed.
1426
1427         iter::process_results(iter.into_iter(), |i| i.collect())
1428     }
1429 }
1430
1431 #[unstable(feature = "try_trait", issue = "42327")]
1432 impl<T,E> ops::Try for Result<T, E> {
1433     type Ok = T;
1434     type Error = E;
1435
1436     #[inline]
1437     fn into_result(self) -> Self {
1438         self
1439     }
1440
1441     #[inline]
1442     fn from_ok(v: T) -> Self {
1443         Ok(v)
1444     }
1445
1446     #[inline]
1447     fn from_error(v: E) -> Self {
1448         Err(v)
1449     }
1450 }