1 //! Error handling with the `Result` type.
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.
9 //! # #[allow(dead_code)]
10 //! enum Result<T, E> {
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).
20 //! A simple function returning [`Result`] might be
21 //! defined and used like so:
25 //! enum Version { Version1, Version2 }
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"),
36 //! let version = parse_version(&[1, 2, 3, 4]);
38 //! Ok(v) => println!("working with version: {:?}", v),
39 //! Err(e) => println!("error parsing header: {:?}", e),
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.
48 //! let good_result: Result<i32, i32> = Ok(10);
49 //! let bad_result: Result<i32, i32> = Err(10);
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());
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);
59 //! // Use `and_then` to continue the computation.
60 //! let good_result: Result<bool, i32> = good_result.and_then(|i| Ok(i == 11));
62 //! // Use `or_else` to handle the error.
63 //! let bad_result: Result<i32, i32> = bad_result.or_else(|i| Ok(i + 20));
65 //! // Consume the result and return the contents with `unwrap`.
66 //! let final_awesome_result = good_result.unwrap();
69 //! # Results must be used
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
79 //! Consider the [`write_all`] method defined for I/O types
80 //! by the [`Write`] trait:
86 //! fn write_all(&mut self, bytes: &[u8]) -> Result<(), io::Error>;
90 //! *Note: The actual definition of [`Write`] uses [`io::Result`], which
91 //! is just a synonym for <code>[Result]<T, [io::Error]></code>.*
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:
98 //! # #![allow(unused_must_use)] // \o/
99 //! use std::fs::File;
100 //! use std::io::prelude::*;
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");
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).
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:
116 //! use std::fs::File;
117 //! use std::io::prelude::*;
119 //! let mut file = File::create("valuable_data.txt").unwrap();
120 //! file.write_all(b"important message").expect("failed to write message");
123 //! You might also simply assert success:
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());
132 //! Or propagate the error up the call stack with [`?`]:
135 //! # use std::fs::File;
136 //! # use std::io::prelude::*;
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")?;
146 //! # The question mark operator, `?`
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.
153 //! It replaces this:
156 //! # #![allow(dead_code)]
157 //! use std::fs::File;
158 //! use std::io::prelude::*;
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),
173 //! if let Err(e) = file.write_all(format!("name: {}\n", info.name).as_bytes()) {
176 //! if let Err(e) = file.write_all(format!("age: {}\n", info.age).as_bytes()) {
179 //! if let Err(e) = file.write_all(format!("rating: {}\n", info.rating).as_bytes()) {
189 //! # #![allow(dead_code)]
190 //! use std::fs::File;
191 //! use std::io::prelude::*;
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())?;
210 //! *It's much nicer!*
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.
216 //! [`?`] can only be used in functions that return [`Result`] because of the
217 //! early return of [`Err`] that it provides.
219 //! [`expect`]: Result::expect
220 //! [`Write`]: ../../std/io/trait.Write.html "io::Write"
221 //! [`write_all`]: ../../std/io/trait.Write.html#method.write_all "io::Write::write_all"
222 //! [`io::Result`]: ../../std/io/type.Result.html "io::Result"
223 //! [`?`]: crate::ops::Try
226 //! [io::Error]: ../../std/io/struct.Error.html "io::Error"
228 //! # Method overview
230 //! In addition to working with pattern matching, [`Result`] provides a
231 //! wide variety of different methods.
233 //! ## Querying the variant
235 //! The [`is_ok`] and [`is_err`] methods return [`true`] if the [`Result`]
236 //! is [`Ok`] or [`Err`], respectively.
238 //! [`is_err`]: Result::is_err
239 //! [`is_ok`]: Result::is_ok
241 //! ## Adapters for working with references
243 //! * [`as_ref`] converts from `&Result<T, E>` to `Result<&T, &E>`
244 //! * [`as_mut`] converts from `&mut Result<T, E>` to `Result<&mut T, &mut E>`
245 //! * [`as_deref`] converts from `&Result<T, E>` to `Result<&T::Target, &E>`
246 //! * [`as_deref_mut`] converts from `&mut Result<T, E>` to
247 //! `Result<&mut T::Target, &mut E>`
249 //! [`as_deref`]: Result::as_deref
250 //! [`as_deref_mut`]: Result::as_deref_mut
251 //! [`as_mut`]: Result::as_mut
252 //! [`as_ref`]: Result::as_ref
254 //! ## Extracting contained values
256 //! These methods extract the contained value in a [`Result<T, E>`] when it
257 //! is the [`Ok`] variant. If the [`Result`] is [`Err`]:
259 //! * [`expect`] panics with a provided custom message
260 //! * [`unwrap`] panics with a generic message
261 //! * [`unwrap_or`] returns the provided default value
262 //! * [`unwrap_or_default`] returns the default value of the type `T`
263 //! (which must implement the [`Default`] trait)
264 //! * [`unwrap_or_else`] returns the result of evaluating the provided
267 //! The panicking methods [`expect`] and [`unwrap`] require `E` to
268 //! implement the [`Debug`] trait.
270 //! [`Debug`]: crate::fmt::Debug
271 //! [`expect`]: Result::expect
272 //! [`unwrap`]: Result::unwrap
273 //! [`unwrap_or`]: Result::unwrap_or
274 //! [`unwrap_or_default`]: Result::unwrap_or_default
275 //! [`unwrap_or_else`]: Result::unwrap_or_else
277 //! These methods extract the contained value in a [`Result<T, E>`] when it
278 //! is the [`Err`] variant. They require `T` to implement the [`Debug`]
279 //! trait. If the [`Result`] is [`Ok`]:
281 //! * [`expect_err`] panics with a provided custom message
282 //! * [`unwrap_err`] panics with a generic message
284 //! [`Debug`]: crate::fmt::Debug
285 //! [`expect_err`]: Result::expect_err
286 //! [`unwrap_err`]: Result::unwrap_err
288 //! ## Transforming contained values
290 //! These methods transform [`Result`] to [`Option`]:
292 //! * [`err`][Result::err] transforms [`Result<T, E>`] into [`Option<E>`],
293 //! mapping [`Err(e)`] to [`Some(e)`] and [`Ok(v)`] to [`None`]
294 //! * [`ok`][Result::ok] transforms [`Result<T, E>`] into [`Option<T>`],
295 //! mapping [`Ok(v)`] to [`Some(v)`] and [`Err(e)`] to [`None`]
296 //! * [`transpose`] transposes a [`Result`] of an [`Option`] into an
297 //! [`Option`] of a [`Result`]
299 // Do NOT add link reference definitions for `err` or `ok`, because they
300 // will generate numerous incorrect URLs for `Err` and `Ok` elsewhere, due
305 //! [`Some(e)`]: Option::Some
306 //! [`Some(v)`]: Option::Some
307 //! [`transpose`]: Result::transpose
309 //! This method transforms the contained value of the [`Ok`] variant:
311 //! * [`map`] transforms [`Result<T, E>`] into [`Result<U, E>`] by applying
312 //! the provided function to the contained value of [`Ok`] and leaving
313 //! [`Err`] values unchanged
315 //! [`map`]: Result::map
317 //! This method transforms the contained value of the [`Err`] variant:
319 //! * [`map_err`] transforms [`Result<T, E>`] into [`Result<T, F>`] by
320 //! applying the provided function to the contained value of [`Err`] and
321 //! leaving [`Ok`] values unchanged
323 //! [`map_err`]: Result::map_err
325 //! These methods transform a [`Result<T, E>`] into a value of a possibly
326 //! different type `U`:
328 //! * [`map_or`] applies the provided function to the contained value of
329 //! [`Ok`], or returns the provided default value if the [`Result`] is
331 //! * [`map_or_else`] applies the provided function to the contained value
332 //! of [`Ok`], or applies the provided default fallback function to the
333 //! contained value of [`Err`]
335 //! [`map_or`]: Result::map_or
336 //! [`map_or_else`]: Result::map_or_else
338 //! ## Boolean operators
340 //! These methods treat the [`Result`] as a boolean value, where [`Ok`]
341 //! acts like [`true`] and [`Err`] acts like [`false`]. There are two
342 //! categories of these methods: ones that take a [`Result`] as input, and
343 //! ones that take a function as input (to be lazily evaluated).
345 //! The [`and`] and [`or`] methods take another [`Result`] as input, and
346 //! produce a [`Result`] as output. The [`and`] method can produce a
347 //! [`Result<U, E>`] value having a different inner type `U` than
348 //! [`Result<T, E>`]. The [`or`] method can produce a [`Result<T, F>`]
349 //! value having a different error type `F` than [`Result<T, E>`].
351 //! | method | self | input | output |
352 //! |---------|----------|-----------|----------|
353 //! | [`and`] | `Err(e)` | (ignored) | `Err(e)` |
354 //! | [`and`] | `Ok(x)` | `Err(d)` | `Err(d)` |
355 //! | [`and`] | `Ok(x)` | `Ok(y)` | `Ok(y)` |
356 //! | [`or`] | `Err(e)` | `Err(d)` | `Err(d)` |
357 //! | [`or`] | `Err(e)` | `Ok(y)` | `Ok(y)` |
358 //! | [`or`] | `Ok(x)` | (ignored) | `Ok(x)` |
360 //! [`and`]: Result::and
361 //! [`or`]: Result::or
363 //! The [`and_then`] and [`or_else`] methods take a function as input, and
364 //! only evaluate the function when they need to produce a new value. The
365 //! [`and_then`] method can produce a [`Result<U, E>`] value having a
366 //! different inner type `U` than [`Result<T, E>`]. The [`or_else`] method
367 //! can produce a [`Result<T, F>`] value having a different error type `F`
368 //! than [`Result<T, E>`].
370 //! | method | self | function input | function result | output |
371 //! |--------------|----------|----------------|-----------------|----------|
372 //! | [`and_then`] | `Err(e)` | (not provided) | (not evaluated) | `Err(e)` |
373 //! | [`and_then`] | `Ok(x)` | `x` | `Err(d)` | `Err(d)` |
374 //! | [`and_then`] | `Ok(x)` | `x` | `Ok(y)` | `Ok(y)` |
375 //! | [`or_else`] | `Err(e)` | `e` | `Err(d)` | `Err(d)` |
376 //! | [`or_else`] | `Err(e)` | `e` | `Ok(y)` | `Ok(y)` |
377 //! | [`or_else`] | `Ok(x)` | (not provided) | (not evaluated) | `Ok(x)` |
379 //! [`and_then`]: Result::and_then
380 //! [`or_else`]: Result::or_else
382 //! ## Comparison operators
384 //! If `T` and `E` both implement [`PartialOrd`] then [`Result<T, E>`] will
385 //! derive its [`PartialOrd`] implementation. With this order, an [`Ok`]
386 //! compares as less than any [`Err`], while two [`Ok`] or two [`Err`]
387 //! compare as their contained values would in `T` or `E` respectively. If `T`
388 //! and `E` both also implement [`Ord`], then so does [`Result<T, E>`].
391 //! assert!(Ok(1) < Err(0));
392 //! let x: Result<i32, ()> = Ok(0);
395 //! let x: Result<(), i32> = Err(0);
400 //! ## Iterating over `Result`
402 //! A [`Result`] can be iterated over. This can be helpful if you need an
403 //! iterator that is conditionally empty. The iterator will either produce
404 //! a single value (when the [`Result`] is [`Ok`]), or produce no values
405 //! (when the [`Result`] is [`Err`]). For example, [`into_iter`] acts like
406 //! [`once(v)`] if the [`Result`] is [`Ok(v)`], and like [`empty()`] if the
407 //! [`Result`] is [`Err`].
410 //! [`empty()`]: crate::iter::empty
411 //! [`once(v)`]: crate::iter::once
413 //! Iterators over [`Result<T, E>`] come in three types:
415 //! * [`into_iter`] consumes the [`Result`] and produces the contained
417 //! * [`iter`] produces an immutable reference of type `&T` to the
419 //! * [`iter_mut`] produces a mutable reference of type `&mut T` to the
422 //! See [Iterating over `Option`] for examples of how this can be useful.
424 //! [Iterating over `Option`]: crate::option#iterating-over-option
425 //! [`into_iter`]: Result::into_iter
426 //! [`iter`]: Result::iter
427 //! [`iter_mut`]: Result::iter_mut
429 //! You might want to use an iterator chain to do multiple instances of an
430 //! operation that can fail, but would like to ignore failures while
431 //! continuing to process the successful results. In this example, we take
432 //! advantage of the iterable nature of [`Result`] to select only the
433 //! [`Ok`] values using [`flatten`][Iterator::flatten].
436 //! # use std::str::FromStr;
437 //! let mut results = vec![];
438 //! let mut errs = vec![];
439 //! let nums: Vec<_> = vec!["17", "not a number", "99", "-27", "768"]
441 //! .map(u8::from_str)
442 //! // Save clones of the raw `Result` values to inspect
443 //! .inspect(|x| results.push(x.clone()))
444 //! // Challenge: explain how this captures only the `Err` values
445 //! .inspect(|x| errs.extend(x.clone().err()))
448 //! assert_eq!(errs.len(), 3);
449 //! assert_eq!(nums, [17, 99]);
450 //! println!("results {:?}", results);
451 //! println!("errs {:?}", errs);
452 //! println!("nums {:?}", nums);
455 //! ## Collecting into `Result`
457 //! [`Result`] implements the [`FromIterator`][impl-FromIterator] trait,
458 //! which allows an iterator over [`Result`] values to be collected into a
459 //! [`Result`] of a collection of each contained value of the original
460 //! [`Result`] values, or [`Err`] if any of the elements was [`Err`].
462 //! [impl-FromIterator]: Result#impl-FromIterator%3CResult%3CA%2C%20E%3E%3E
465 //! let v = vec![Ok(2), Ok(4), Err("err!"), Ok(8)];
466 //! let res: Result<Vec<_>, &str> = v.into_iter().collect();
467 //! assert_eq!(res, Err("err!"));
468 //! let v = vec![Ok(2), Ok(4), Ok(8)];
469 //! let res: Result<Vec<_>, &str> = v.into_iter().collect();
470 //! assert_eq!(res, Ok(vec![2, 4, 8]));
473 //! [`Result`] also implements the [`Product`][impl-Product] and
474 //! [`Sum`][impl-Sum] traits, allowing an iterator over [`Result`] values
475 //! to provide the [`product`][Iterator::product] and
476 //! [`sum`][Iterator::sum] methods.
478 //! [impl-Product]: Result#impl-Product%3CResult%3CU%2C%20E%3E%3E
479 //! [impl-Sum]: Result#impl-Sum%3CResult%3CU%2C%20E%3E%3E
482 //! let v = vec![Err("error!"), Ok(1), Ok(2), Ok(3), Err("foo")];
483 //! let res: Result<i32, &str> = v.into_iter().sum();
484 //! assert_eq!(res, Err("error!"));
485 //! let v: Vec<Result<i32, &str>> = vec![Ok(1), Ok(2), Ok(21)];
486 //! let res: Result<i32, &str> = v.into_iter().product();
487 //! assert_eq!(res, Ok(42));
490 #![stable(feature = "rust1", since = "1.0.0")]
492 use crate::iter::{self, FromIterator, FusedIterator, TrustedLen};
493 use crate::ops::{self, ControlFlow, Deref, DerefMut};
494 use crate::{convert, fmt, hint};
496 /// `Result` is a type that represents either success ([`Ok`]) or failure ([`Err`]).
498 /// See the [module documentation](self) for details.
499 #[derive(Copy, PartialEq, PartialOrd, Eq, Ord, Debug, Hash)]
500 #[must_use = "this `Result` may be an `Err` variant, which should be handled"]
501 #[rustc_diagnostic_item = "Result"]
502 #[stable(feature = "rust1", since = "1.0.0")]
503 pub enum Result<T, E> {
504 /// Contains the success value
506 #[stable(feature = "rust1", since = "1.0.0")]
507 Ok(#[stable(feature = "rust1", since = "1.0.0")] T),
509 /// Contains the error value
511 #[stable(feature = "rust1", since = "1.0.0")]
512 Err(#[stable(feature = "rust1", since = "1.0.0")] E),
515 /////////////////////////////////////////////////////////////////////////////
516 // Type implementation
517 /////////////////////////////////////////////////////////////////////////////
519 impl<T, E> Result<T, E> {
520 /////////////////////////////////////////////////////////////////////////
521 // Querying the contained values
522 /////////////////////////////////////////////////////////////////////////
524 /// Returns `true` if the result is [`Ok`].
531 /// let x: Result<i32, &str> = Ok(-3);
532 /// assert_eq!(x.is_ok(), true);
534 /// let x: Result<i32, &str> = Err("Some error message");
535 /// assert_eq!(x.is_ok(), false);
537 #[must_use = "if you intended to assert that this is ok, consider `.unwrap()` instead"]
538 #[rustc_const_stable(feature = "const_result", since = "1.48.0")]
540 #[stable(feature = "rust1", since = "1.0.0")]
541 pub const fn is_ok(&self) -> bool {
542 matches!(*self, Ok(_))
545 /// Returns `true` if the result is [`Err`].
552 /// let x: Result<i32, &str> = Ok(-3);
553 /// assert_eq!(x.is_err(), false);
555 /// let x: Result<i32, &str> = Err("Some error message");
556 /// assert_eq!(x.is_err(), true);
558 #[must_use = "if you intended to assert that this is err, consider `.unwrap_err()` instead"]
559 #[rustc_const_stable(feature = "const_result", since = "1.48.0")]
561 #[stable(feature = "rust1", since = "1.0.0")]
562 pub const fn is_err(&self) -> bool {
566 /// Returns `true` if the result is an [`Ok`] value containing the given value.
571 /// #![feature(option_result_contains)]
573 /// let x: Result<u32, &str> = Ok(2);
574 /// assert_eq!(x.contains(&2), true);
576 /// let x: Result<u32, &str> = Ok(3);
577 /// assert_eq!(x.contains(&2), false);
579 /// let x: Result<u32, &str> = Err("Some error message");
580 /// assert_eq!(x.contains(&2), false);
584 #[unstable(feature = "option_result_contains", issue = "62358")]
585 pub fn contains<U>(&self, x: &U) -> bool
595 /// Returns `true` if the result is an [`Err`] value containing the given value.
600 /// #![feature(result_contains_err)]
602 /// let x: Result<u32, &str> = Ok(2);
603 /// assert_eq!(x.contains_err(&"Some error message"), false);
605 /// let x: Result<u32, &str> = Err("Some error message");
606 /// assert_eq!(x.contains_err(&"Some error message"), true);
608 /// let x: Result<u32, &str> = Err("Some other error message");
609 /// assert_eq!(x.contains_err(&"Some error message"), false);
613 #[unstable(feature = "result_contains_err", issue = "62358")]
614 pub fn contains_err<F>(&self, f: &F) -> bool
624 /////////////////////////////////////////////////////////////////////////
625 // Adapter for each variant
626 /////////////////////////////////////////////////////////////////////////
628 /// Converts from `Result<T, E>` to [`Option<T>`].
630 /// Converts `self` into an [`Option<T>`], consuming `self`,
631 /// and discarding the error, if any.
638 /// let x: Result<u32, &str> = Ok(2);
639 /// assert_eq!(x.ok(), Some(2));
641 /// let x: Result<u32, &str> = Err("Nothing here");
642 /// assert_eq!(x.ok(), None);
645 #[stable(feature = "rust1", since = "1.0.0")]
646 pub fn ok(self) -> Option<T> {
653 /// Converts from `Result<T, E>` to [`Option<E>`].
655 /// Converts `self` into an [`Option<E>`], consuming `self`,
656 /// and discarding the success value, if any.
663 /// let x: Result<u32, &str> = Ok(2);
664 /// assert_eq!(x.err(), None);
666 /// let x: Result<u32, &str> = Err("Nothing here");
667 /// assert_eq!(x.err(), Some("Nothing here"));
670 #[stable(feature = "rust1", since = "1.0.0")]
671 pub fn err(self) -> Option<E> {
678 /////////////////////////////////////////////////////////////////////////
679 // Adapter for working with references
680 /////////////////////////////////////////////////////////////////////////
682 /// Converts from `&Result<T, E>` to `Result<&T, &E>`.
684 /// Produces a new `Result`, containing a reference
685 /// into the original, leaving the original in place.
692 /// let x: Result<u32, &str> = Ok(2);
693 /// assert_eq!(x.as_ref(), Ok(&2));
695 /// let x: Result<u32, &str> = Err("Error");
696 /// assert_eq!(x.as_ref(), Err(&"Error"));
699 #[rustc_const_stable(feature = "const_result", since = "1.48.0")]
700 #[stable(feature = "rust1", since = "1.0.0")]
701 pub const fn as_ref(&self) -> Result<&T, &E> {
704 Err(ref x) => Err(x),
708 /// Converts from `&mut Result<T, E>` to `Result<&mut T, &mut E>`.
715 /// fn mutate(r: &mut Result<i32, i32>) {
716 /// match r.as_mut() {
717 /// Ok(v) => *v = 42,
718 /// Err(e) => *e = 0,
722 /// let mut x: Result<i32, i32> = Ok(2);
724 /// assert_eq!(x.unwrap(), 42);
726 /// let mut x: Result<i32, i32> = Err(13);
728 /// assert_eq!(x.unwrap_err(), 0);
731 #[stable(feature = "rust1", since = "1.0.0")]
732 #[rustc_const_unstable(feature = "const_result", issue = "82814")]
733 pub const fn as_mut(&mut self) -> Result<&mut T, &mut E> {
735 Ok(ref mut x) => Ok(x),
736 Err(ref mut x) => Err(x),
740 /////////////////////////////////////////////////////////////////////////
741 // Transforming contained values
742 /////////////////////////////////////////////////////////////////////////
744 /// Maps a `Result<T, E>` to `Result<U, E>` by applying a function to a
745 /// contained [`Ok`] value, leaving an [`Err`] value untouched.
747 /// This function can be used to compose the results of two functions.
751 /// Print the numbers on each line of a string multiplied by two.
754 /// let line = "1\n2\n3\n4\n";
756 /// for num in line.lines() {
757 /// match num.parse::<i32>().map(|i| i * 2) {
758 /// Ok(n) => println!("{}", n),
764 #[stable(feature = "rust1", since = "1.0.0")]
765 pub fn map<U, F: FnOnce(T) -> U>(self, op: F) -> Result<U, E> {
772 /// Returns the provided default (if [`Err`]), or
773 /// applies a function to the contained value (if [`Ok`]),
775 /// Arguments passed to `map_or` are eagerly evaluated; if you are passing
776 /// the result of a function call, it is recommended to use [`map_or_else`],
777 /// which is lazily evaluated.
779 /// [`map_or_else`]: Result::map_or_else
784 /// let x: Result<_, &str> = Ok("foo");
785 /// assert_eq!(x.map_or(42, |v| v.len()), 3);
787 /// let x: Result<&str, _> = Err("bar");
788 /// assert_eq!(x.map_or(42, |v| v.len()), 42);
791 #[stable(feature = "result_map_or", since = "1.41.0")]
792 pub fn map_or<U, F: FnOnce(T) -> U>(self, default: U, f: F) -> U {
799 /// Maps a `Result<T, E>` to `U` by applying fallback function `default` to
800 /// a contained [`Err`] value, or function `f` to a contained [`Ok`] value.
802 /// This function can be used to unpack a successful result
803 /// while handling an error.
813 /// let x : Result<_, &str> = Ok("foo");
814 /// assert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);
816 /// let x : Result<&str, _> = Err("bar");
817 /// assert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
820 #[stable(feature = "result_map_or_else", since = "1.41.0")]
821 pub fn map_or_else<U, D: FnOnce(E) -> U, F: FnOnce(T) -> U>(self, default: D, f: F) -> U {
824 Err(e) => default(e),
828 /// Maps a `Result<T, E>` to `Result<T, F>` by applying a function to a
829 /// contained [`Err`] value, leaving an [`Ok`] value untouched.
831 /// This function can be used to pass through a successful result while handling
840 /// fn stringify(x: u32) -> String { format!("error code: {}", x) }
842 /// let x: Result<u32, u32> = Ok(2);
843 /// assert_eq!(x.map_err(stringify), Ok(2));
845 /// let x: Result<u32, u32> = Err(13);
846 /// assert_eq!(x.map_err(stringify), Err("error code: 13".to_string()));
849 #[stable(feature = "rust1", since = "1.0.0")]
850 pub fn map_err<F, O: FnOnce(E) -> F>(self, op: O) -> Result<T, F> {
853 Err(e) => Err(op(e)),
857 /// Calls the provided closure with a reference to the contained value (if [`Ok`]).
862 /// #![feature(result_option_inspect)]
866 /// .inspect(|x| println!("original: {}", x))
867 /// .map(|x| x.pow(3))
868 /// .expect("failed to parse number");
871 #[unstable(feature = "result_option_inspect", issue = "91345")]
872 pub fn inspect<F: FnOnce(&T)>(self, f: F) -> Self {
873 if let Ok(ref t) = self {
880 /// Calls the provided closure with a reference to the contained error (if [`Err`]).
885 /// #![feature(result_option_inspect)]
887 /// use std::{fs, io};
889 /// fn read() -> io::Result<String> {
890 /// fs::read_to_string("address.txt")
891 /// .inspect_err(|e| eprintln!("failed to read file: {}", e))
895 #[unstable(feature = "result_option_inspect", issue = "91345")]
896 pub fn inspect_err<F: FnOnce(&E)>(self, f: F) -> Self {
897 if let Err(ref e) = self {
904 /// Converts from `Result<T, E>` (or `&Result<T, E>`) to `Result<&<T as Deref>::Target, &E>`.
906 /// Coerces the [`Ok`] variant of the original [`Result`] via [`Deref`](crate::ops::Deref)
907 /// and returns the new [`Result`].
912 /// let x: Result<String, u32> = Ok("hello".to_string());
913 /// let y: Result<&str, &u32> = Ok("hello");
914 /// assert_eq!(x.as_deref(), y);
916 /// let x: Result<String, u32> = Err(42);
917 /// let y: Result<&str, &u32> = Err(&42);
918 /// assert_eq!(x.as_deref(), y);
920 #[stable(feature = "inner_deref", since = "1.47.0")]
921 pub fn as_deref(&self) -> Result<&T::Target, &E>
925 self.as_ref().map(|t| t.deref())
928 /////////////////////////////////////////////////////////////////////////
929 // Iterator constructors
930 /////////////////////////////////////////////////////////////////////////
932 /// Returns an iterator over the possibly contained value.
934 /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
941 /// let x: Result<u32, &str> = Ok(7);
942 /// assert_eq!(x.iter().next(), Some(&7));
944 /// let x: Result<u32, &str> = Err("nothing!");
945 /// assert_eq!(x.iter().next(), None);
948 #[stable(feature = "rust1", since = "1.0.0")]
949 pub fn iter(&self) -> Iter<'_, T> {
950 Iter { inner: self.as_ref().ok() }
953 /// Returns a mutable iterator over the possibly contained value.
955 /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
962 /// let mut x: Result<u32, &str> = Ok(7);
963 /// match x.iter_mut().next() {
964 /// Some(v) => *v = 40,
967 /// assert_eq!(x, Ok(40));
969 /// let mut x: Result<u32, &str> = Err("nothing!");
970 /// assert_eq!(x.iter_mut().next(), None);
973 #[stable(feature = "rust1", since = "1.0.0")]
974 pub fn iter_mut(&mut self) -> IterMut<'_, T> {
975 IterMut { inner: self.as_mut().ok() }
978 ////////////////////////////////////////////////////////////////////////
979 // Boolean operations on the values, eager and lazy
980 /////////////////////////////////////////////////////////////////////////
982 /// Returns `res` if the result is [`Ok`], otherwise returns the [`Err`] value of `self`.
990 /// let x: Result<u32, &str> = Ok(2);
991 /// let y: Result<&str, &str> = Err("late error");
992 /// assert_eq!(x.and(y), Err("late error"));
994 /// let x: Result<u32, &str> = Err("early error");
995 /// let y: Result<&str, &str> = Ok("foo");
996 /// assert_eq!(x.and(y), Err("early error"));
998 /// let x: Result<u32, &str> = Err("not a 2");
999 /// let y: Result<&str, &str> = Err("late error");
1000 /// assert_eq!(x.and(y), Err("not a 2"));
1002 /// let x: Result<u32, &str> = Ok(2);
1003 /// let y: Result<&str, &str> = Ok("different result type");
1004 /// assert_eq!(x.and(y), Ok("different result type"));
1007 #[stable(feature = "rust1", since = "1.0.0")]
1008 pub fn and<U>(self, res: Result<U, E>) -> Result<U, E> {
1015 /// Calls `op` if the result is [`Ok`], otherwise returns the [`Err`] value of `self`.
1018 /// This function can be used for control flow based on `Result` values.
1025 /// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
1026 /// fn err(x: u32) -> Result<u32, u32> { Err(x) }
1028 /// assert_eq!(Ok(2).and_then(sq).and_then(sq), Ok(16));
1029 /// assert_eq!(Ok(2).and_then(sq).and_then(err), Err(4));
1030 /// assert_eq!(Ok(2).and_then(err).and_then(sq), Err(2));
1031 /// assert_eq!(Err(3).and_then(sq).and_then(sq), Err(3));
1034 #[stable(feature = "rust1", since = "1.0.0")]
1035 pub fn and_then<U, F: FnOnce(T) -> Result<U, E>>(self, op: F) -> Result<U, E> {
1042 /// Returns `res` if the result is [`Err`], otherwise returns the [`Ok`] value of `self`.
1044 /// Arguments passed to `or` are eagerly evaluated; if you are passing the
1045 /// result of a function call, it is recommended to use [`or_else`], which is
1046 /// lazily evaluated.
1048 /// [`or_else`]: Result::or_else
1055 /// let x: Result<u32, &str> = Ok(2);
1056 /// let y: Result<u32, &str> = Err("late error");
1057 /// assert_eq!(x.or(y), Ok(2));
1059 /// let x: Result<u32, &str> = Err("early error");
1060 /// let y: Result<u32, &str> = Ok(2);
1061 /// assert_eq!(x.or(y), Ok(2));
1063 /// let x: Result<u32, &str> = Err("not a 2");
1064 /// let y: Result<u32, &str> = Err("late error");
1065 /// assert_eq!(x.or(y), Err("late error"));
1067 /// let x: Result<u32, &str> = Ok(2);
1068 /// let y: Result<u32, &str> = Ok(100);
1069 /// assert_eq!(x.or(y), Ok(2));
1072 #[stable(feature = "rust1", since = "1.0.0")]
1073 pub fn or<F>(self, res: Result<T, F>) -> Result<T, F> {
1080 /// Calls `op` if the result is [`Err`], otherwise returns the [`Ok`] value of `self`.
1082 /// This function can be used for control flow based on result values.
1090 /// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
1091 /// fn err(x: u32) -> Result<u32, u32> { Err(x) }
1093 /// assert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));
1094 /// assert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));
1095 /// assert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));
1096 /// assert_eq!(Err(3).or_else(err).or_else(err), Err(3));
1099 #[stable(feature = "rust1", since = "1.0.0")]
1100 pub fn or_else<F, O: FnOnce(E) -> Result<T, F>>(self, op: O) -> Result<T, F> {
1107 /// Returns the contained [`Ok`] value or a provided default.
1109 /// Arguments passed to `unwrap_or` are eagerly evaluated; if you are passing
1110 /// the result of a function call, it is recommended to use [`unwrap_or_else`],
1111 /// which is lazily evaluated.
1113 /// [`unwrap_or_else`]: Result::unwrap_or_else
1120 /// let default = 2;
1121 /// let x: Result<u32, &str> = Ok(9);
1122 /// assert_eq!(x.unwrap_or(default), 9);
1124 /// let x: Result<u32, &str> = Err("error");
1125 /// assert_eq!(x.unwrap_or(default), default);
1128 #[stable(feature = "rust1", since = "1.0.0")]
1129 pub fn unwrap_or(self, default: T) -> T {
1136 /// Returns the contained [`Ok`] value or computes it from a closure.
1144 /// fn count(x: &str) -> usize { x.len() }
1146 /// assert_eq!(Ok(2).unwrap_or_else(count), 2);
1147 /// assert_eq!(Err("foo").unwrap_or_else(count), 3);
1150 #[stable(feature = "rust1", since = "1.0.0")]
1151 pub fn unwrap_or_else<F: FnOnce(E) -> T>(self, op: F) -> T {
1158 /// Returns the contained [`Ok`] value, consuming the `self` value,
1159 /// without checking that the value is not an [`Err`].
1163 /// Calling this method on an [`Err`] is *[undefined behavior]*.
1165 /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
1170 /// let x: Result<u32, &str> = Ok(2);
1171 /// assert_eq!(unsafe { x.unwrap_unchecked() }, 2);
1175 /// let x: Result<u32, &str> = Err("emergency failure");
1176 /// unsafe { x.unwrap_unchecked(); } // Undefined behavior!
1180 #[stable(feature = "option_result_unwrap_unchecked", since = "1.58.0")]
1181 pub unsafe fn unwrap_unchecked(self) -> T {
1182 debug_assert!(self.is_ok());
1185 // SAFETY: the safety contract must be upheld by the caller.
1186 Err(_) => unsafe { hint::unreachable_unchecked() },
1190 /// Returns the contained [`Err`] value, consuming the `self` value,
1191 /// without checking that the value is not an [`Ok`].
1195 /// Calling this method on an [`Ok`] is *[undefined behavior]*.
1197 /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
1202 /// let x: Result<u32, &str> = Ok(2);
1203 /// unsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
1207 /// let x: Result<u32, &str> = Err("emergency failure");
1208 /// assert_eq!(unsafe { x.unwrap_err_unchecked() }, "emergency failure");
1212 #[stable(feature = "option_result_unwrap_unchecked", since = "1.58.0")]
1213 pub unsafe fn unwrap_err_unchecked(self) -> E {
1214 debug_assert!(self.is_err());
1216 // SAFETY: the safety contract must be upheld by the caller.
1217 Ok(_) => unsafe { hint::unreachable_unchecked() },
1223 impl<T: Copy, E> Result<&T, E> {
1224 /// Maps a `Result<&T, E>` to a `Result<T, E>` by copying the contents of the
1230 /// #![feature(result_copied)]
1232 /// let x: Result<&i32, i32> = Ok(&val);
1233 /// assert_eq!(x, Ok(&12));
1234 /// let copied = x.copied();
1235 /// assert_eq!(copied, Ok(12));
1237 #[unstable(feature = "result_copied", reason = "newly added", issue = "63168")]
1238 pub fn copied(self) -> Result<T, E> {
1243 impl<T: Copy, E> Result<&mut T, E> {
1244 /// Maps a `Result<&mut T, E>` to a `Result<T, E>` by copying the contents of the
1250 /// #![feature(result_copied)]
1251 /// let mut val = 12;
1252 /// let x: Result<&mut i32, i32> = Ok(&mut val);
1253 /// assert_eq!(x, Ok(&mut 12));
1254 /// let copied = x.copied();
1255 /// assert_eq!(copied, Ok(12));
1257 #[unstable(feature = "result_copied", reason = "newly added", issue = "63168")]
1258 pub fn copied(self) -> Result<T, E> {
1259 self.map(|&mut t| t)
1263 impl<T: Clone, E> Result<&T, E> {
1264 /// Maps a `Result<&T, E>` to a `Result<T, E>` by cloning the contents of the
1270 /// #![feature(result_cloned)]
1272 /// let x: Result<&i32, i32> = Ok(&val);
1273 /// assert_eq!(x, Ok(&12));
1274 /// let cloned = x.cloned();
1275 /// assert_eq!(cloned, Ok(12));
1277 #[unstable(feature = "result_cloned", reason = "newly added", issue = "63168")]
1278 pub fn cloned(self) -> Result<T, E> {
1279 self.map(|t| t.clone())
1283 impl<T: Clone, E> Result<&mut T, E> {
1284 /// Maps a `Result<&mut T, E>` to a `Result<T, E>` by cloning the contents of the
1290 /// #![feature(result_cloned)]
1291 /// let mut val = 12;
1292 /// let x: Result<&mut i32, i32> = Ok(&mut val);
1293 /// assert_eq!(x, Ok(&mut 12));
1294 /// let cloned = x.cloned();
1295 /// assert_eq!(cloned, Ok(12));
1297 #[unstable(feature = "result_cloned", reason = "newly added", issue = "63168")]
1298 pub fn cloned(self) -> Result<T, E> {
1299 self.map(|t| t.clone())
1303 impl<T, E: fmt::Debug> Result<T, E> {
1304 /// Returns the contained [`Ok`] value, consuming the `self` value.
1308 /// Panics if the value is an [`Err`], with a panic message including the
1309 /// passed message, and the content of the [`Err`].
1317 /// let x: Result<u32, &str> = Err("emergency failure");
1318 /// x.expect("Testing expect"); // panics with `Testing expect: emergency failure`
1322 #[stable(feature = "result_expect", since = "1.4.0")]
1323 pub fn expect(self, msg: &str) -> T {
1326 Err(e) => unwrap_failed(msg, &e),
1330 /// Returns the contained [`Ok`] value, consuming the `self` value.
1332 /// Because this function may panic, its use is generally discouraged.
1333 /// Instead, prefer to use pattern matching and handle the [`Err`]
1334 /// case explicitly, or call [`unwrap_or`], [`unwrap_or_else`], or
1335 /// [`unwrap_or_default`].
1337 /// [`unwrap_or`]: Result::unwrap_or
1338 /// [`unwrap_or_else`]: Result::unwrap_or_else
1339 /// [`unwrap_or_default`]: Result::unwrap_or_default
1343 /// Panics if the value is an [`Err`], with a panic message provided by the
1344 /// [`Err`]'s value.
1352 /// let x: Result<u32, &str> = Ok(2);
1353 /// assert_eq!(x.unwrap(), 2);
1357 /// let x: Result<u32, &str> = Err("emergency failure");
1358 /// x.unwrap(); // panics with `emergency failure`
1362 #[stable(feature = "rust1", since = "1.0.0")]
1363 pub fn unwrap(self) -> T {
1366 Err(e) => unwrap_failed("called `Result::unwrap()` on an `Err` value", &e),
1371 impl<T: fmt::Debug, E> Result<T, E> {
1372 /// Returns the contained [`Err`] value, consuming the `self` value.
1376 /// Panics if the value is an [`Ok`], with a panic message including the
1377 /// passed message, and the content of the [`Ok`].
1385 /// let x: Result<u32, &str> = Ok(10);
1386 /// x.expect_err("Testing expect_err"); // panics with `Testing expect_err: 10`
1390 #[stable(feature = "result_expect_err", since = "1.17.0")]
1391 pub fn expect_err(self, msg: &str) -> E {
1393 Ok(t) => unwrap_failed(msg, &t),
1398 /// Returns the contained [`Err`] value, consuming the `self` value.
1402 /// Panics if the value is an [`Ok`], with a custom panic message provided
1403 /// by the [`Ok`]'s value.
1408 /// let x: Result<u32, &str> = Ok(2);
1409 /// x.unwrap_err(); // panics with `2`
1413 /// let x: Result<u32, &str> = Err("emergency failure");
1414 /// assert_eq!(x.unwrap_err(), "emergency failure");
1418 #[stable(feature = "rust1", since = "1.0.0")]
1419 pub fn unwrap_err(self) -> E {
1421 Ok(t) => unwrap_failed("called `Result::unwrap_err()` on an `Ok` value", &t),
1427 impl<T: Default, E> Result<T, E> {
1428 /// Returns the contained [`Ok`] value or a default
1430 /// Consumes the `self` argument then, if [`Ok`], returns the contained
1431 /// value, otherwise if [`Err`], returns the default value for that
1436 /// Converts a string to an integer, turning poorly-formed strings
1437 /// into 0 (the default value for integers). [`parse`] converts
1438 /// a string to any other type that implements [`FromStr`], returning an
1439 /// [`Err`] on error.
1442 /// let good_year_from_input = "1909";
1443 /// let bad_year_from_input = "190blarg";
1444 /// let good_year = good_year_from_input.parse().unwrap_or_default();
1445 /// let bad_year = bad_year_from_input.parse().unwrap_or_default();
1447 /// assert_eq!(1909, good_year);
1448 /// assert_eq!(0, bad_year);
1451 /// [`parse`]: str::parse
1452 /// [`FromStr`]: crate::str::FromStr
1454 #[stable(feature = "result_unwrap_or_default", since = "1.16.0")]
1455 pub fn unwrap_or_default(self) -> T {
1458 Err(_) => Default::default(),
1463 #[unstable(feature = "unwrap_infallible", reason = "newly added", issue = "61695")]
1464 impl<T, E: Into<!>> Result<T, E> {
1465 /// Returns the contained [`Ok`] value, but never panics.
1467 /// Unlike [`unwrap`], this method is known to never panic on the
1468 /// result types it is implemented for. Therefore, it can be used
1469 /// instead of `unwrap` as a maintainability safeguard that will fail
1470 /// to compile if the error type of the `Result` is later changed
1471 /// to an error that can actually occur.
1473 /// [`unwrap`]: Result::unwrap
1480 /// # #![feature(never_type)]
1481 /// # #![feature(unwrap_infallible)]
1483 /// fn only_good_news() -> Result<String, !> {
1484 /// Ok("this is fine".into())
1487 /// let s: String = only_good_news().into_ok();
1488 /// println!("{}", s);
1491 pub fn into_ok(self) -> T {
1499 #[unstable(feature = "unwrap_infallible", reason = "newly added", issue = "61695")]
1500 impl<T: Into<!>, E> Result<T, E> {
1501 /// Returns the contained [`Err`] value, but never panics.
1503 /// Unlike [`unwrap_err`], this method is known to never panic on the
1504 /// result types it is implemented for. Therefore, it can be used
1505 /// instead of `unwrap_err` as a maintainability safeguard that will fail
1506 /// to compile if the ok type of the `Result` is later changed
1507 /// to a type that can actually occur.
1509 /// [`unwrap_err`]: Result::unwrap_err
1516 /// # #![feature(never_type)]
1517 /// # #![feature(unwrap_infallible)]
1519 /// fn only_bad_news() -> Result<!, String> {
1520 /// Err("Oops, it failed".into())
1523 /// let error: String = only_bad_news().into_err();
1524 /// println!("{}", error);
1527 pub fn into_err(self) -> E {
1535 impl<T: DerefMut, E> Result<T, E> {
1536 /// Converts from `Result<T, E>` (or `&mut Result<T, E>`) to `Result<&mut <T as DerefMut>::Target, &mut E>`.
1538 /// Coerces the [`Ok`] variant of the original [`Result`] via [`DerefMut`](crate::ops::DerefMut)
1539 /// and returns the new [`Result`].
1544 /// let mut s = "HELLO".to_string();
1545 /// let mut x: Result<String, u32> = Ok("hello".to_string());
1546 /// let y: Result<&mut str, &mut u32> = Ok(&mut s);
1547 /// assert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
1550 /// let mut x: Result<String, u32> = Err(42);
1551 /// let y: Result<&mut str, &mut u32> = Err(&mut i);
1552 /// assert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
1554 #[stable(feature = "inner_deref", since = "1.47.0")]
1555 pub fn as_deref_mut(&mut self) -> Result<&mut T::Target, &mut E> {
1556 self.as_mut().map(|t| t.deref_mut())
1560 impl<T, E> Result<Option<T>, E> {
1561 /// Transposes a `Result` of an `Option` into an `Option` of a `Result`.
1563 /// `Ok(None)` will be mapped to `None`.
1564 /// `Ok(Some(_))` and `Err(_)` will be mapped to `Some(Ok(_))` and `Some(Err(_))`.
1569 /// #[derive(Debug, Eq, PartialEq)]
1572 /// let x: Result<Option<i32>, SomeErr> = Ok(Some(5));
1573 /// let y: Option<Result<i32, SomeErr>> = Some(Ok(5));
1574 /// assert_eq!(x.transpose(), y);
1577 #[stable(feature = "transpose_result", since = "1.33.0")]
1578 #[rustc_const_unstable(feature = "const_result", issue = "82814")]
1579 pub const fn transpose(self) -> Option<Result<T, E>> {
1581 Ok(Some(x)) => Some(Ok(x)),
1583 Err(e) => Some(Err(e)),
1588 impl<T, E> Result<Result<T, E>, E> {
1589 /// Converts from `Result<Result<T, E>, E>` to `Result<T, E>`
1596 /// #![feature(result_flattening)]
1597 /// let x: Result<Result<&'static str, u32>, u32> = Ok(Ok("hello"));
1598 /// assert_eq!(Ok("hello"), x.flatten());
1600 /// let x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));
1601 /// assert_eq!(Err(6), x.flatten());
1603 /// let x: Result<Result<&'static str, u32>, u32> = Err(6);
1604 /// assert_eq!(Err(6), x.flatten());
1607 /// Flattening only removes one level of nesting at a time:
1610 /// #![feature(result_flattening)]
1611 /// let x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok("hello")));
1612 /// assert_eq!(Ok(Ok("hello")), x.flatten());
1613 /// assert_eq!(Ok("hello"), x.flatten().flatten());
1616 #[unstable(feature = "result_flattening", issue = "70142")]
1617 pub fn flatten(self) -> Result<T, E> {
1618 self.and_then(convert::identity)
1622 impl<T> Result<T, T> {
1623 /// Returns the [`Ok`] value if `self` is `Ok`, and the [`Err`] value if
1624 /// `self` is `Err`.
1626 /// In other words, this function returns the value (the `T`) of a
1627 /// `Result<T, T>`, regardless of whether or not that result is `Ok` or
1630 /// This can be useful in conjunction with APIs such as
1631 /// [`Atomic*::compare_exchange`], or [`slice::binary_search`], but only in
1632 /// cases where you don't care if the result was `Ok` or not.
1634 /// [`Atomic*::compare_exchange`]: crate::sync::atomic::AtomicBool::compare_exchange
1639 /// #![feature(result_into_ok_or_err)]
1640 /// let ok: Result<u32, u32> = Ok(3);
1641 /// let err: Result<u32, u32> = Err(4);
1643 /// assert_eq!(ok.into_ok_or_err(), 3);
1644 /// assert_eq!(err.into_ok_or_err(), 4);
1647 #[unstable(feature = "result_into_ok_or_err", reason = "newly added", issue = "82223")]
1648 pub const fn into_ok_or_err(self) -> T {
1656 // This is a separate function to reduce the code size of the methods
1657 #[cfg(not(feature = "panic_immediate_abort"))]
1661 fn unwrap_failed(msg: &str, error: &dyn fmt::Debug) -> ! {
1662 panic!("{}: {:?}", msg, error)
1665 // This is a separate function to avoid constructing a `dyn Debug`
1666 // that gets immediately thrown away, since vtables don't get cleaned up
1667 // by dead code elimination if a trait object is constructed even if it goes
1669 #[cfg(feature = "panic_immediate_abort")]
1673 fn unwrap_failed<T>(_msg: &str, _error: &T) -> ! {
1677 /////////////////////////////////////////////////////////////////////////////
1678 // Trait implementations
1679 /////////////////////////////////////////////////////////////////////////////
1681 #[stable(feature = "rust1", since = "1.0.0")]
1682 impl<T: Clone, E: Clone> Clone for Result<T, E> {
1684 fn clone(&self) -> Self {
1686 Ok(x) => Ok(x.clone()),
1687 Err(x) => Err(x.clone()),
1692 fn clone_from(&mut self, source: &Self) {
1693 match (self, source) {
1694 (Ok(to), Ok(from)) => to.clone_from(from),
1695 (Err(to), Err(from)) => to.clone_from(from),
1696 (to, from) => *to = from.clone(),
1701 #[stable(feature = "rust1", since = "1.0.0")]
1702 impl<T, E> IntoIterator for Result<T, E> {
1704 type IntoIter = IntoIter<T>;
1706 /// Returns a consuming iterator over the possibly contained value.
1708 /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
1715 /// let x: Result<u32, &str> = Ok(5);
1716 /// let v: Vec<u32> = x.into_iter().collect();
1717 /// assert_eq!(v, [5]);
1719 /// let x: Result<u32, &str> = Err("nothing!");
1720 /// let v: Vec<u32> = x.into_iter().collect();
1721 /// assert_eq!(v, []);
1724 fn into_iter(self) -> IntoIter<T> {
1725 IntoIter { inner: self.ok() }
1729 #[stable(since = "1.4.0", feature = "result_iter")]
1730 impl<'a, T, E> IntoIterator for &'a Result<T, E> {
1732 type IntoIter = Iter<'a, T>;
1734 fn into_iter(self) -> Iter<'a, T> {
1739 #[stable(since = "1.4.0", feature = "result_iter")]
1740 impl<'a, T, E> IntoIterator for &'a mut Result<T, E> {
1741 type Item = &'a mut T;
1742 type IntoIter = IterMut<'a, T>;
1744 fn into_iter(self) -> IterMut<'a, T> {
1749 /////////////////////////////////////////////////////////////////////////////
1750 // The Result Iterators
1751 /////////////////////////////////////////////////////////////////////////////
1753 /// An iterator over a reference to the [`Ok`] variant of a [`Result`].
1755 /// The iterator yields one value if the result is [`Ok`], otherwise none.
1757 /// Created by [`Result::iter`].
1759 #[stable(feature = "rust1", since = "1.0.0")]
1760 pub struct Iter<'a, T: 'a> {
1761 inner: Option<&'a T>,
1764 #[stable(feature = "rust1", since = "1.0.0")]
1765 impl<'a, T> Iterator for Iter<'a, T> {
1769 fn next(&mut self) -> Option<&'a T> {
1773 fn size_hint(&self) -> (usize, Option<usize>) {
1774 let n = if self.inner.is_some() { 1 } else { 0 };
1779 #[stable(feature = "rust1", since = "1.0.0")]
1780 impl<'a, T> DoubleEndedIterator for Iter<'a, T> {
1782 fn next_back(&mut self) -> Option<&'a T> {
1787 #[stable(feature = "rust1", since = "1.0.0")]
1788 impl<T> ExactSizeIterator for Iter<'_, T> {}
1790 #[stable(feature = "fused", since = "1.26.0")]
1791 impl<T> FusedIterator for Iter<'_, T> {}
1793 #[unstable(feature = "trusted_len", issue = "37572")]
1794 unsafe impl<A> TrustedLen for Iter<'_, A> {}
1796 #[stable(feature = "rust1", since = "1.0.0")]
1797 impl<T> Clone for Iter<'_, T> {
1799 fn clone(&self) -> Self {
1800 Iter { inner: self.inner }
1804 /// An iterator over a mutable reference to the [`Ok`] variant of a [`Result`].
1806 /// Created by [`Result::iter_mut`].
1808 #[stable(feature = "rust1", since = "1.0.0")]
1809 pub struct IterMut<'a, T: 'a> {
1810 inner: Option<&'a mut T>,
1813 #[stable(feature = "rust1", since = "1.0.0")]
1814 impl<'a, T> Iterator for IterMut<'a, T> {
1815 type Item = &'a mut T;
1818 fn next(&mut self) -> Option<&'a mut T> {
1822 fn size_hint(&self) -> (usize, Option<usize>) {
1823 let n = if self.inner.is_some() { 1 } else { 0 };
1828 #[stable(feature = "rust1", since = "1.0.0")]
1829 impl<'a, T> DoubleEndedIterator for IterMut<'a, T> {
1831 fn next_back(&mut self) -> Option<&'a mut T> {
1836 #[stable(feature = "rust1", since = "1.0.0")]
1837 impl<T> ExactSizeIterator for IterMut<'_, T> {}
1839 #[stable(feature = "fused", since = "1.26.0")]
1840 impl<T> FusedIterator for IterMut<'_, T> {}
1842 #[unstable(feature = "trusted_len", issue = "37572")]
1843 unsafe impl<A> TrustedLen for IterMut<'_, A> {}
1845 /// An iterator over the value in a [`Ok`] variant of a [`Result`].
1847 /// The iterator yields one value if the result is [`Ok`], otherwise none.
1849 /// This struct is created by the [`into_iter`] method on
1850 /// [`Result`] (provided by the [`IntoIterator`] trait).
1852 /// [`into_iter`]: IntoIterator::into_iter
1853 #[derive(Clone, Debug)]
1854 #[stable(feature = "rust1", since = "1.0.0")]
1855 pub struct IntoIter<T> {
1859 #[stable(feature = "rust1", since = "1.0.0")]
1860 impl<T> Iterator for IntoIter<T> {
1864 fn next(&mut self) -> Option<T> {
1868 fn size_hint(&self) -> (usize, Option<usize>) {
1869 let n = if self.inner.is_some() { 1 } else { 0 };
1874 #[stable(feature = "rust1", since = "1.0.0")]
1875 impl<T> DoubleEndedIterator for IntoIter<T> {
1877 fn next_back(&mut self) -> Option<T> {
1882 #[stable(feature = "rust1", since = "1.0.0")]
1883 impl<T> ExactSizeIterator for IntoIter<T> {}
1885 #[stable(feature = "fused", since = "1.26.0")]
1886 impl<T> FusedIterator for IntoIter<T> {}
1888 #[unstable(feature = "trusted_len", issue = "37572")]
1889 unsafe impl<A> TrustedLen for IntoIter<A> {}
1891 /////////////////////////////////////////////////////////////////////////////
1893 /////////////////////////////////////////////////////////////////////////////
1895 #[stable(feature = "rust1", since = "1.0.0")]
1896 impl<A, E, V: FromIterator<A>> FromIterator<Result<A, E>> for Result<V, E> {
1897 /// Takes each element in the `Iterator`: if it is an `Err`, no further
1898 /// elements are taken, and the `Err` is returned. Should no `Err` occur, a
1899 /// container with the values of each `Result` is returned.
1901 /// Here is an example which increments every integer in a vector,
1902 /// checking for overflow:
1905 /// let v = vec![1, 2];
1906 /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
1907 /// x.checked_add(1).ok_or("Overflow!")
1909 /// assert_eq!(res, Ok(vec![2, 3]));
1912 /// Here is another example that tries to subtract one from another list
1913 /// of integers, this time checking for underflow:
1916 /// let v = vec![1, 2, 0];
1917 /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
1918 /// x.checked_sub(1).ok_or("Underflow!")
1920 /// assert_eq!(res, Err("Underflow!"));
1923 /// Here is a variation on the previous example, showing that no
1924 /// further elements are taken from `iter` after the first `Err`.
1927 /// let v = vec![3, 2, 1, 10];
1928 /// let mut shared = 0;
1929 /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {
1931 /// x.checked_sub(2).ok_or("Underflow!")
1933 /// assert_eq!(res, Err("Underflow!"));
1934 /// assert_eq!(shared, 6);
1937 /// Since the third element caused an underflow, no further elements were taken,
1938 /// so the final value of `shared` is 6 (= `3 + 2 + 1`), not 16.
1940 fn from_iter<I: IntoIterator<Item = Result<A, E>>>(iter: I) -> Result<V, E> {
1941 // FIXME(#11084): This could be replaced with Iterator::scan when this
1942 // performance bug is closed.
1944 iter::process_results(iter.into_iter(), |i| i.collect())
1948 #[unstable(feature = "try_trait_v2", issue = "84277")]
1949 #[rustc_const_unstable(feature = "const_convert", issue = "88674")]
1950 impl<T, E> const ops::Try for Result<T, E> {
1952 type Residual = Result<convert::Infallible, E>;
1955 fn from_output(output: Self::Output) -> Self {
1960 fn branch(self) -> ControlFlow<Self::Residual, Self::Output> {
1962 Ok(v) => ControlFlow::Continue(v),
1963 Err(e) => ControlFlow::Break(Err(e)),
1968 #[unstable(feature = "try_trait_v2", issue = "84277")]
1969 #[rustc_const_unstable(feature = "const_convert", issue = "88674")]
1970 impl<T, E, F: ~const From<E>> const ops::FromResidual<Result<convert::Infallible, E>>
1975 fn from_residual(residual: Result<convert::Infallible, E>) -> Self {
1977 Err(e) => Err(From::from(e)),
1982 #[unstable(feature = "try_trait_v2_residual", issue = "91285")]
1983 impl<T, E> ops::Residual<T> for Result<convert::Infallible, E> {
1984 type TryType = Result<T, E>;