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<_> = ["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 = [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 = [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 = [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 = [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 /////////////////////////////////////////////////////////////////////////
567 // Adapter for each variant
568 /////////////////////////////////////////////////////////////////////////
570 /// Converts from `Result<T, E>` to [`Option<T>`].
572 /// Converts `self` into an [`Option<T>`], consuming `self`,
573 /// and discarding the error, if any.
580 /// let x: Result<u32, &str> = Ok(2);
581 /// assert_eq!(x.ok(), Some(2));
583 /// let x: Result<u32, &str> = Err("Nothing here");
584 /// assert_eq!(x.ok(), None);
587 #[stable(feature = "rust1", since = "1.0.0")]
588 pub fn ok(self) -> Option<T> {
595 /// Converts from `Result<T, E>` to [`Option<E>`].
597 /// Converts `self` into an [`Option<E>`], consuming `self`,
598 /// and discarding the success value, if any.
605 /// let x: Result<u32, &str> = Ok(2);
606 /// assert_eq!(x.err(), None);
608 /// let x: Result<u32, &str> = Err("Nothing here");
609 /// assert_eq!(x.err(), Some("Nothing here"));
612 #[stable(feature = "rust1", since = "1.0.0")]
613 pub fn err(self) -> Option<E> {
620 /////////////////////////////////////////////////////////////////////////
621 // Adapter for working with references
622 /////////////////////////////////////////////////////////////////////////
624 /// Converts from `&Result<T, E>` to `Result<&T, &E>`.
626 /// Produces a new `Result`, containing a reference
627 /// into the original, leaving the original in place.
634 /// let x: Result<u32, &str> = Ok(2);
635 /// assert_eq!(x.as_ref(), Ok(&2));
637 /// let x: Result<u32, &str> = Err("Error");
638 /// assert_eq!(x.as_ref(), Err(&"Error"));
641 #[rustc_const_stable(feature = "const_result", since = "1.48.0")]
642 #[stable(feature = "rust1", since = "1.0.0")]
643 pub const fn as_ref(&self) -> Result<&T, &E> {
646 Err(ref x) => Err(x),
650 /// Converts from `&mut Result<T, E>` to `Result<&mut T, &mut E>`.
657 /// fn mutate(r: &mut Result<i32, i32>) {
658 /// match r.as_mut() {
659 /// Ok(v) => *v = 42,
660 /// Err(e) => *e = 0,
664 /// let mut x: Result<i32, i32> = Ok(2);
666 /// assert_eq!(x.unwrap(), 42);
668 /// let mut x: Result<i32, i32> = Err(13);
670 /// assert_eq!(x.unwrap_err(), 0);
673 #[stable(feature = "rust1", since = "1.0.0")]
674 #[rustc_const_unstable(feature = "const_result", issue = "82814")]
675 pub const fn as_mut(&mut self) -> Result<&mut T, &mut E> {
677 Ok(ref mut x) => Ok(x),
678 Err(ref mut x) => Err(x),
682 /////////////////////////////////////////////////////////////////////////
683 // Transforming contained values
684 /////////////////////////////////////////////////////////////////////////
686 /// Maps a `Result<T, E>` to `Result<U, E>` by applying a function to a
687 /// contained [`Ok`] value, leaving an [`Err`] value untouched.
689 /// This function can be used to compose the results of two functions.
693 /// Print the numbers on each line of a string multiplied by two.
696 /// let line = "1\n2\n3\n4\n";
698 /// for num in line.lines() {
699 /// match num.parse::<i32>().map(|i| i * 2) {
700 /// Ok(n) => println!("{}", n),
706 #[stable(feature = "rust1", since = "1.0.0")]
707 pub fn map<U, F: FnOnce(T) -> U>(self, op: F) -> Result<U, E> {
714 /// Returns the provided default (if [`Err`]), or
715 /// applies a function to the contained value (if [`Ok`]),
717 /// Arguments passed to `map_or` are eagerly evaluated; if you are passing
718 /// the result of a function call, it is recommended to use [`map_or_else`],
719 /// which is lazily evaluated.
721 /// [`map_or_else`]: Result::map_or_else
726 /// let x: Result<_, &str> = Ok("foo");
727 /// assert_eq!(x.map_or(42, |v| v.len()), 3);
729 /// let x: Result<&str, _> = Err("bar");
730 /// assert_eq!(x.map_or(42, |v| v.len()), 42);
733 #[stable(feature = "result_map_or", since = "1.41.0")]
734 pub fn map_or<U, F: FnOnce(T) -> U>(self, default: U, f: F) -> U {
741 /// Maps a `Result<T, E>` to `U` by applying fallback function `default` to
742 /// a contained [`Err`] value, or function `f` to a contained [`Ok`] value.
744 /// This function can be used to unpack a successful result
745 /// while handling an error.
755 /// let x : Result<_, &str> = Ok("foo");
756 /// assert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);
758 /// let x : Result<&str, _> = Err("bar");
759 /// assert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
762 #[stable(feature = "result_map_or_else", since = "1.41.0")]
763 pub fn map_or_else<U, D: FnOnce(E) -> U, F: FnOnce(T) -> U>(self, default: D, f: F) -> U {
766 Err(e) => default(e),
770 /// Maps a `Result<T, E>` to `Result<T, F>` by applying a function to a
771 /// contained [`Err`] value, leaving an [`Ok`] value untouched.
773 /// This function can be used to pass through a successful result while handling
782 /// fn stringify(x: u32) -> String { format!("error code: {}", x) }
784 /// let x: Result<u32, u32> = Ok(2);
785 /// assert_eq!(x.map_err(stringify), Ok(2));
787 /// let x: Result<u32, u32> = Err(13);
788 /// assert_eq!(x.map_err(stringify), Err("error code: 13".to_string()));
791 #[stable(feature = "rust1", since = "1.0.0")]
792 pub fn map_err<F, O: FnOnce(E) -> F>(self, op: O) -> Result<T, F> {
795 Err(e) => Err(op(e)),
799 /// Calls the provided closure with a reference to the contained value (if [`Ok`]).
804 /// #![feature(result_option_inspect)]
808 /// .inspect(|x| println!("original: {}", x))
809 /// .map(|x| x.pow(3))
810 /// .expect("failed to parse number");
813 #[unstable(feature = "result_option_inspect", issue = "91345")]
814 pub fn inspect<F: FnOnce(&T)>(self, f: F) -> Self {
815 if let Ok(ref t) = self {
822 /// Calls the provided closure with a reference to the contained error (if [`Err`]).
827 /// #![feature(result_option_inspect)]
829 /// use std::{fs, io};
831 /// fn read() -> io::Result<String> {
832 /// fs::read_to_string("address.txt")
833 /// .inspect_err(|e| eprintln!("failed to read file: {}", e))
837 #[unstable(feature = "result_option_inspect", issue = "91345")]
838 pub fn inspect_err<F: FnOnce(&E)>(self, f: F) -> Self {
839 if let Err(ref e) = self {
846 /// Converts from `Result<T, E>` (or `&Result<T, E>`) to `Result<&<T as Deref>::Target, &E>`.
848 /// Coerces the [`Ok`] variant of the original [`Result`] via [`Deref`](crate::ops::Deref)
849 /// and returns the new [`Result`].
854 /// let x: Result<String, u32> = Ok("hello".to_string());
855 /// let y: Result<&str, &u32> = Ok("hello");
856 /// assert_eq!(x.as_deref(), y);
858 /// let x: Result<String, u32> = Err(42);
859 /// let y: Result<&str, &u32> = Err(&42);
860 /// assert_eq!(x.as_deref(), y);
862 #[stable(feature = "inner_deref", since = "1.47.0")]
863 pub fn as_deref(&self) -> Result<&T::Target, &E>
867 self.as_ref().map(|t| t.deref())
870 /// Converts from `Result<T, E>` (or `&mut Result<T, E>`) to `Result<&mut <T as DerefMut>::Target, &mut E>`.
872 /// Coerces the [`Ok`] variant of the original [`Result`] via [`DerefMut`](crate::ops::DerefMut)
873 /// and returns the new [`Result`].
878 /// let mut s = "HELLO".to_string();
879 /// let mut x: Result<String, u32> = Ok("hello".to_string());
880 /// let y: Result<&mut str, &mut u32> = Ok(&mut s);
881 /// assert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
884 /// let mut x: Result<String, u32> = Err(42);
885 /// let y: Result<&mut str, &mut u32> = Err(&mut i);
886 /// assert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
888 #[stable(feature = "inner_deref", since = "1.47.0")]
889 pub fn as_deref_mut(&mut self) -> Result<&mut T::Target, &mut E>
893 self.as_mut().map(|t| t.deref_mut())
896 /////////////////////////////////////////////////////////////////////////
897 // Iterator constructors
898 /////////////////////////////////////////////////////////////////////////
900 /// Returns an iterator over the possibly contained value.
902 /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
909 /// let x: Result<u32, &str> = Ok(7);
910 /// assert_eq!(x.iter().next(), Some(&7));
912 /// let x: Result<u32, &str> = Err("nothing!");
913 /// assert_eq!(x.iter().next(), None);
916 #[stable(feature = "rust1", since = "1.0.0")]
917 pub fn iter(&self) -> Iter<'_, T> {
918 Iter { inner: self.as_ref().ok() }
921 /// Returns a mutable iterator over the possibly contained value.
923 /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
930 /// let mut x: Result<u32, &str> = Ok(7);
931 /// match x.iter_mut().next() {
932 /// Some(v) => *v = 40,
935 /// assert_eq!(x, Ok(40));
937 /// let mut x: Result<u32, &str> = Err("nothing!");
938 /// assert_eq!(x.iter_mut().next(), None);
941 #[stable(feature = "rust1", since = "1.0.0")]
942 pub fn iter_mut(&mut self) -> IterMut<'_, T> {
943 IterMut { inner: self.as_mut().ok() }
946 /////////////////////////////////////////////////////////////////////////
948 /////////////////////////////////////////////////////////////////////////
950 /// Returns the contained [`Ok`] value, consuming the `self` value.
954 /// Panics if the value is an [`Err`], with a panic message including the
955 /// passed message, and the content of the [`Err`].
963 /// let x: Result<u32, &str> = Err("emergency failure");
964 /// x.expect("Testing expect"); // panics with `Testing expect: emergency failure`
968 #[stable(feature = "result_expect", since = "1.4.0")]
969 pub fn expect(self, msg: &str) -> T
975 Err(e) => unwrap_failed(msg, &e),
979 /// Returns the contained [`Ok`] value, consuming the `self` value.
981 /// Because this function may panic, its use is generally discouraged.
982 /// Instead, prefer to use pattern matching and handle the [`Err`]
983 /// case explicitly, or call [`unwrap_or`], [`unwrap_or_else`], or
984 /// [`unwrap_or_default`].
986 /// [`unwrap_or`]: Result::unwrap_or
987 /// [`unwrap_or_else`]: Result::unwrap_or_else
988 /// [`unwrap_or_default`]: Result::unwrap_or_default
992 /// Panics if the value is an [`Err`], with a panic message provided by the
1001 /// let x: Result<u32, &str> = Ok(2);
1002 /// assert_eq!(x.unwrap(), 2);
1006 /// let x: Result<u32, &str> = Err("emergency failure");
1007 /// x.unwrap(); // panics with `emergency failure`
1011 #[stable(feature = "rust1", since = "1.0.0")]
1012 pub fn unwrap(self) -> T
1018 Err(e) => unwrap_failed("called `Result::unwrap()` on an `Err` value", &e),
1022 /// Returns the contained [`Ok`] value or a default
1024 /// Consumes the `self` argument then, if [`Ok`], returns the contained
1025 /// value, otherwise if [`Err`], returns the default value for that
1030 /// Converts a string to an integer, turning poorly-formed strings
1031 /// into 0 (the default value for integers). [`parse`] converts
1032 /// a string to any other type that implements [`FromStr`], returning an
1033 /// [`Err`] on error.
1036 /// let good_year_from_input = "1909";
1037 /// let bad_year_from_input = "190blarg";
1038 /// let good_year = good_year_from_input.parse().unwrap_or_default();
1039 /// let bad_year = bad_year_from_input.parse().unwrap_or_default();
1041 /// assert_eq!(1909, good_year);
1042 /// assert_eq!(0, bad_year);
1045 /// [`parse`]: str::parse
1046 /// [`FromStr`]: crate::str::FromStr
1048 #[stable(feature = "result_unwrap_or_default", since = "1.16.0")]
1049 pub fn unwrap_or_default(self) -> T
1055 Err(_) => Default::default(),
1059 /// Returns the contained [`Err`] value, consuming the `self` value.
1063 /// Panics if the value is an [`Ok`], with a panic message including the
1064 /// passed message, and the content of the [`Ok`].
1072 /// let x: Result<u32, &str> = Ok(10);
1073 /// x.expect_err("Testing expect_err"); // panics with `Testing expect_err: 10`
1077 #[stable(feature = "result_expect_err", since = "1.17.0")]
1078 pub fn expect_err(self, msg: &str) -> E
1083 Ok(t) => unwrap_failed(msg, &t),
1088 /// Returns the contained [`Err`] value, consuming the `self` value.
1092 /// Panics if the value is an [`Ok`], with a custom panic message provided
1093 /// by the [`Ok`]'s value.
1098 /// let x: Result<u32, &str> = Ok(2);
1099 /// x.unwrap_err(); // panics with `2`
1103 /// let x: Result<u32, &str> = Err("emergency failure");
1104 /// assert_eq!(x.unwrap_err(), "emergency failure");
1108 #[stable(feature = "rust1", since = "1.0.0")]
1109 pub fn unwrap_err(self) -> E
1114 Ok(t) => unwrap_failed("called `Result::unwrap_err()` on an `Ok` value", &t),
1119 /// Returns the contained [`Ok`] value, but never panics.
1121 /// Unlike [`unwrap`], this method is known to never panic on the
1122 /// result types it is implemented for. Therefore, it can be used
1123 /// instead of `unwrap` as a maintainability safeguard that will fail
1124 /// to compile if the error type of the `Result` is later changed
1125 /// to an error that can actually occur.
1127 /// [`unwrap`]: Result::unwrap
1134 /// # #![feature(never_type)]
1135 /// # #![feature(unwrap_infallible)]
1137 /// fn only_good_news() -> Result<String, !> {
1138 /// Ok("this is fine".into())
1141 /// let s: String = only_good_news().into_ok();
1142 /// println!("{}", s);
1144 #[unstable(feature = "unwrap_infallible", reason = "newly added", issue = "61695")]
1146 pub fn into_ok(self) -> T
1156 /// Returns the contained [`Err`] value, but never panics.
1158 /// Unlike [`unwrap_err`], this method is known to never panic on the
1159 /// result types it is implemented for. Therefore, it can be used
1160 /// instead of `unwrap_err` as a maintainability safeguard that will fail
1161 /// to compile if the ok type of the `Result` is later changed
1162 /// to a type that can actually occur.
1164 /// [`unwrap_err`]: Result::unwrap_err
1171 /// # #![feature(never_type)]
1172 /// # #![feature(unwrap_infallible)]
1174 /// fn only_bad_news() -> Result<!, String> {
1175 /// Err("Oops, it failed".into())
1178 /// let error: String = only_bad_news().into_err();
1179 /// println!("{}", error);
1181 #[unstable(feature = "unwrap_infallible", reason = "newly added", issue = "61695")]
1183 pub fn into_err(self) -> E
1193 ////////////////////////////////////////////////////////////////////////
1194 // Boolean operations on the values, eager and lazy
1195 /////////////////////////////////////////////////////////////////////////
1197 /// Returns `res` if the result is [`Ok`], otherwise returns the [`Err`] value of `self`.
1205 /// let x: Result<u32, &str> = Ok(2);
1206 /// let y: Result<&str, &str> = Err("late error");
1207 /// assert_eq!(x.and(y), Err("late error"));
1209 /// let x: Result<u32, &str> = Err("early error");
1210 /// let y: Result<&str, &str> = Ok("foo");
1211 /// assert_eq!(x.and(y), Err("early error"));
1213 /// let x: Result<u32, &str> = Err("not a 2");
1214 /// let y: Result<&str, &str> = Err("late error");
1215 /// assert_eq!(x.and(y), Err("not a 2"));
1217 /// let x: Result<u32, &str> = Ok(2);
1218 /// let y: Result<&str, &str> = Ok("different result type");
1219 /// assert_eq!(x.and(y), Ok("different result type"));
1222 #[stable(feature = "rust1", since = "1.0.0")]
1223 pub fn and<U>(self, res: Result<U, E>) -> Result<U, E> {
1230 /// Calls `op` if the result is [`Ok`], otherwise returns the [`Err`] value of `self`.
1233 /// This function can be used for control flow based on `Result` values.
1240 /// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
1241 /// fn err(x: u32) -> Result<u32, u32> { Err(x) }
1243 /// assert_eq!(Ok(2).and_then(sq).and_then(sq), Ok(16));
1244 /// assert_eq!(Ok(2).and_then(sq).and_then(err), Err(4));
1245 /// assert_eq!(Ok(2).and_then(err).and_then(sq), Err(2));
1246 /// assert_eq!(Err(3).and_then(sq).and_then(sq), Err(3));
1249 #[stable(feature = "rust1", since = "1.0.0")]
1250 pub fn and_then<U, F: FnOnce(T) -> Result<U, E>>(self, op: F) -> Result<U, E> {
1257 /// Returns `res` if the result is [`Err`], otherwise returns the [`Ok`] value of `self`.
1259 /// Arguments passed to `or` are eagerly evaluated; if you are passing the
1260 /// result of a function call, it is recommended to use [`or_else`], which is
1261 /// lazily evaluated.
1263 /// [`or_else`]: Result::or_else
1270 /// let x: Result<u32, &str> = Ok(2);
1271 /// let y: Result<u32, &str> = Err("late error");
1272 /// assert_eq!(x.or(y), Ok(2));
1274 /// let x: Result<u32, &str> = Err("early error");
1275 /// let y: Result<u32, &str> = Ok(2);
1276 /// assert_eq!(x.or(y), Ok(2));
1278 /// let x: Result<u32, &str> = Err("not a 2");
1279 /// let y: Result<u32, &str> = Err("late error");
1280 /// assert_eq!(x.or(y), Err("late error"));
1282 /// let x: Result<u32, &str> = Ok(2);
1283 /// let y: Result<u32, &str> = Ok(100);
1284 /// assert_eq!(x.or(y), Ok(2));
1287 #[stable(feature = "rust1", since = "1.0.0")]
1288 pub fn or<F>(self, res: Result<T, F>) -> Result<T, F> {
1295 /// Calls `op` if the result is [`Err`], otherwise returns the [`Ok`] value of `self`.
1297 /// This function can be used for control flow based on result values.
1305 /// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
1306 /// fn err(x: u32) -> Result<u32, u32> { Err(x) }
1308 /// assert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));
1309 /// assert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));
1310 /// assert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));
1311 /// assert_eq!(Err(3).or_else(err).or_else(err), Err(3));
1314 #[stable(feature = "rust1", since = "1.0.0")]
1315 pub fn or_else<F, O: FnOnce(E) -> Result<T, F>>(self, op: O) -> Result<T, F> {
1322 /// Returns the contained [`Ok`] value or a provided default.
1324 /// Arguments passed to `unwrap_or` are eagerly evaluated; if you are passing
1325 /// the result of a function call, it is recommended to use [`unwrap_or_else`],
1326 /// which is lazily evaluated.
1328 /// [`unwrap_or_else`]: Result::unwrap_or_else
1335 /// let default = 2;
1336 /// let x: Result<u32, &str> = Ok(9);
1337 /// assert_eq!(x.unwrap_or(default), 9);
1339 /// let x: Result<u32, &str> = Err("error");
1340 /// assert_eq!(x.unwrap_or(default), default);
1343 #[stable(feature = "rust1", since = "1.0.0")]
1344 pub fn unwrap_or(self, default: T) -> T {
1351 /// Returns the contained [`Ok`] value or computes it from a closure.
1359 /// fn count(x: &str) -> usize { x.len() }
1361 /// assert_eq!(Ok(2).unwrap_or_else(count), 2);
1362 /// assert_eq!(Err("foo").unwrap_or_else(count), 3);
1365 #[stable(feature = "rust1", since = "1.0.0")]
1366 pub fn unwrap_or_else<F: FnOnce(E) -> T>(self, op: F) -> T {
1373 /// Returns the contained [`Ok`] value, consuming the `self` value,
1374 /// without checking that the value is not an [`Err`].
1378 /// Calling this method on an [`Err`] is *[undefined behavior]*.
1380 /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
1385 /// let x: Result<u32, &str> = Ok(2);
1386 /// assert_eq!(unsafe { x.unwrap_unchecked() }, 2);
1390 /// let x: Result<u32, &str> = Err("emergency failure");
1391 /// unsafe { x.unwrap_unchecked(); } // Undefined behavior!
1395 #[stable(feature = "option_result_unwrap_unchecked", since = "1.58.0")]
1396 pub unsafe fn unwrap_unchecked(self) -> T {
1397 debug_assert!(self.is_ok());
1400 // SAFETY: the safety contract must be upheld by the caller.
1401 Err(_) => unsafe { hint::unreachable_unchecked() },
1405 /// Returns the contained [`Err`] value, consuming the `self` value,
1406 /// without checking that the value is not an [`Ok`].
1410 /// Calling this method on an [`Ok`] is *[undefined behavior]*.
1412 /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
1417 /// let x: Result<u32, &str> = Ok(2);
1418 /// unsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
1422 /// let x: Result<u32, &str> = Err("emergency failure");
1423 /// assert_eq!(unsafe { x.unwrap_err_unchecked() }, "emergency failure");
1427 #[stable(feature = "option_result_unwrap_unchecked", since = "1.58.0")]
1428 pub unsafe fn unwrap_err_unchecked(self) -> E {
1429 debug_assert!(self.is_err());
1431 // SAFETY: the safety contract must be upheld by the caller.
1432 Ok(_) => unsafe { hint::unreachable_unchecked() },
1437 /////////////////////////////////////////////////////////////////////////
1439 /////////////////////////////////////////////////////////////////////////
1441 /// Returns `true` if the result is an [`Ok`] value containing the given value.
1446 /// #![feature(option_result_contains)]
1448 /// let x: Result<u32, &str> = Ok(2);
1449 /// assert_eq!(x.contains(&2), true);
1451 /// let x: Result<u32, &str> = Ok(3);
1452 /// assert_eq!(x.contains(&2), false);
1454 /// let x: Result<u32, &str> = Err("Some error message");
1455 /// assert_eq!(x.contains(&2), false);
1459 #[unstable(feature = "option_result_contains", issue = "62358")]
1460 pub fn contains<U>(&self, x: &U) -> bool
1470 /// Returns `true` if the result is an [`Err`] value containing the given value.
1475 /// #![feature(result_contains_err)]
1477 /// let x: Result<u32, &str> = Ok(2);
1478 /// assert_eq!(x.contains_err(&"Some error message"), false);
1480 /// let x: Result<u32, &str> = Err("Some error message");
1481 /// assert_eq!(x.contains_err(&"Some error message"), true);
1483 /// let x: Result<u32, &str> = Err("Some other error message");
1484 /// assert_eq!(x.contains_err(&"Some error message"), false);
1488 #[unstable(feature = "result_contains_err", issue = "62358")]
1489 pub fn contains_err<F>(&self, f: &F) -> bool
1500 impl<T, E> Result<&T, E> {
1501 /// Maps a `Result<&T, E>` to a `Result<T, E>` by copying the contents of the
1508 /// let x: Result<&i32, i32> = Ok(&val);
1509 /// assert_eq!(x, Ok(&12));
1510 /// let copied = x.copied();
1511 /// assert_eq!(copied, Ok(12));
1514 #[stable(feature = "result_copied", since = "1.59.0")]
1515 pub fn copied(self) -> Result<T, E>
1522 /// Maps a `Result<&T, E>` to a `Result<T, E>` by cloning the contents of the
1529 /// let x: Result<&i32, i32> = Ok(&val);
1530 /// assert_eq!(x, Ok(&12));
1531 /// let cloned = x.cloned();
1532 /// assert_eq!(cloned, Ok(12));
1535 #[stable(feature = "result_cloned", since = "1.59.0")]
1536 pub fn cloned(self) -> Result<T, E>
1540 self.map(|t| t.clone())
1544 impl<T, E> Result<&mut T, E> {
1545 /// Maps a `Result<&mut T, E>` to a `Result<T, E>` by copying the contents of the
1551 /// let mut val = 12;
1552 /// let x: Result<&mut i32, i32> = Ok(&mut val);
1553 /// assert_eq!(x, Ok(&mut 12));
1554 /// let copied = x.copied();
1555 /// assert_eq!(copied, Ok(12));
1558 #[stable(feature = "result_copied", since = "1.59.0")]
1559 pub fn copied(self) -> Result<T, E>
1563 self.map(|&mut t| t)
1566 /// Maps a `Result<&mut T, E>` to a `Result<T, E>` by cloning the contents of the
1572 /// let mut val = 12;
1573 /// let x: Result<&mut i32, i32> = Ok(&mut val);
1574 /// assert_eq!(x, Ok(&mut 12));
1575 /// let cloned = x.cloned();
1576 /// assert_eq!(cloned, Ok(12));
1579 #[stable(feature = "result_cloned", since = "1.59.0")]
1580 pub fn cloned(self) -> Result<T, E>
1584 self.map(|t| t.clone())
1588 impl<T, E> Result<Option<T>, E> {
1589 /// Transposes a `Result` of an `Option` into an `Option` of a `Result`.
1591 /// `Ok(None)` will be mapped to `None`.
1592 /// `Ok(Some(_))` and `Err(_)` will be mapped to `Some(Ok(_))` and `Some(Err(_))`.
1597 /// #[derive(Debug, Eq, PartialEq)]
1600 /// let x: Result<Option<i32>, SomeErr> = Ok(Some(5));
1601 /// let y: Option<Result<i32, SomeErr>> = Some(Ok(5));
1602 /// assert_eq!(x.transpose(), y);
1605 #[stable(feature = "transpose_result", since = "1.33.0")]
1606 #[rustc_const_unstable(feature = "const_result", issue = "82814")]
1607 pub const fn transpose(self) -> Option<Result<T, E>> {
1609 Ok(Some(x)) => Some(Ok(x)),
1611 Err(e) => Some(Err(e)),
1616 impl<T, E> Result<Result<T, E>, E> {
1617 /// Converts from `Result<Result<T, E>, E>` to `Result<T, E>`
1624 /// #![feature(result_flattening)]
1625 /// let x: Result<Result<&'static str, u32>, u32> = Ok(Ok("hello"));
1626 /// assert_eq!(Ok("hello"), x.flatten());
1628 /// let x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));
1629 /// assert_eq!(Err(6), x.flatten());
1631 /// let x: Result<Result<&'static str, u32>, u32> = Err(6);
1632 /// assert_eq!(Err(6), x.flatten());
1635 /// Flattening only removes one level of nesting at a time:
1638 /// #![feature(result_flattening)]
1639 /// let x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok("hello")));
1640 /// assert_eq!(Ok(Ok("hello")), x.flatten());
1641 /// assert_eq!(Ok("hello"), x.flatten().flatten());
1644 #[unstable(feature = "result_flattening", issue = "70142")]
1645 pub fn flatten(self) -> Result<T, E> {
1646 self.and_then(convert::identity)
1650 impl<T> Result<T, T> {
1651 /// Returns the [`Ok`] value if `self` is `Ok`, and the [`Err`] value if
1652 /// `self` is `Err`.
1654 /// In other words, this function returns the value (the `T`) of a
1655 /// `Result<T, T>`, regardless of whether or not that result is `Ok` or
1658 /// This can be useful in conjunction with APIs such as
1659 /// [`Atomic*::compare_exchange`], or [`slice::binary_search`], but only in
1660 /// cases where you don't care if the result was `Ok` or not.
1662 /// [`Atomic*::compare_exchange`]: crate::sync::atomic::AtomicBool::compare_exchange
1667 /// #![feature(result_into_ok_or_err)]
1668 /// let ok: Result<u32, u32> = Ok(3);
1669 /// let err: Result<u32, u32> = Err(4);
1671 /// assert_eq!(ok.into_ok_or_err(), 3);
1672 /// assert_eq!(err.into_ok_or_err(), 4);
1675 #[unstable(feature = "result_into_ok_or_err", reason = "newly added", issue = "82223")]
1676 pub const fn into_ok_or_err(self) -> T {
1684 // This is a separate function to reduce the code size of the methods
1685 #[cfg(not(feature = "panic_immediate_abort"))]
1689 fn unwrap_failed(msg: &str, error: &dyn fmt::Debug) -> ! {
1690 panic!("{}: {:?}", msg, error)
1693 // This is a separate function to avoid constructing a `dyn Debug`
1694 // that gets immediately thrown away, since vtables don't get cleaned up
1695 // by dead code elimination if a trait object is constructed even if it goes
1697 #[cfg(feature = "panic_immediate_abort")]
1701 fn unwrap_failed<T>(_msg: &str, _error: &T) -> ! {
1705 /////////////////////////////////////////////////////////////////////////////
1706 // Trait implementations
1707 /////////////////////////////////////////////////////////////////////////////
1709 #[stable(feature = "rust1", since = "1.0.0")]
1710 impl<T: Clone, E: Clone> Clone for Result<T, E> {
1712 fn clone(&self) -> Self {
1714 Ok(x) => Ok(x.clone()),
1715 Err(x) => Err(x.clone()),
1720 fn clone_from(&mut self, source: &Self) {
1721 match (self, source) {
1722 (Ok(to), Ok(from)) => to.clone_from(from),
1723 (Err(to), Err(from)) => to.clone_from(from),
1724 (to, from) => *to = from.clone(),
1729 #[stable(feature = "rust1", since = "1.0.0")]
1730 impl<T, E> IntoIterator for Result<T, E> {
1732 type IntoIter = IntoIter<T>;
1734 /// Returns a consuming iterator over the possibly contained value.
1736 /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
1743 /// let x: Result<u32, &str> = Ok(5);
1744 /// let v: Vec<u32> = x.into_iter().collect();
1745 /// assert_eq!(v, [5]);
1747 /// let x: Result<u32, &str> = Err("nothing!");
1748 /// let v: Vec<u32> = x.into_iter().collect();
1749 /// assert_eq!(v, []);
1752 fn into_iter(self) -> IntoIter<T> {
1753 IntoIter { inner: self.ok() }
1757 #[stable(since = "1.4.0", feature = "result_iter")]
1758 impl<'a, T, E> IntoIterator for &'a Result<T, E> {
1760 type IntoIter = Iter<'a, T>;
1762 fn into_iter(self) -> Iter<'a, T> {
1767 #[stable(since = "1.4.0", feature = "result_iter")]
1768 impl<'a, T, E> IntoIterator for &'a mut Result<T, E> {
1769 type Item = &'a mut T;
1770 type IntoIter = IterMut<'a, T>;
1772 fn into_iter(self) -> IterMut<'a, T> {
1777 /////////////////////////////////////////////////////////////////////////////
1778 // The Result Iterators
1779 /////////////////////////////////////////////////////////////////////////////
1781 /// An iterator over a reference to the [`Ok`] variant of a [`Result`].
1783 /// The iterator yields one value if the result is [`Ok`], otherwise none.
1785 /// Created by [`Result::iter`].
1787 #[stable(feature = "rust1", since = "1.0.0")]
1788 pub struct Iter<'a, T: 'a> {
1789 inner: Option<&'a T>,
1792 #[stable(feature = "rust1", since = "1.0.0")]
1793 impl<'a, T> Iterator for Iter<'a, T> {
1797 fn next(&mut self) -> Option<&'a T> {
1801 fn size_hint(&self) -> (usize, Option<usize>) {
1802 let n = if self.inner.is_some() { 1 } else { 0 };
1807 #[stable(feature = "rust1", since = "1.0.0")]
1808 impl<'a, T> DoubleEndedIterator for Iter<'a, T> {
1810 fn next_back(&mut self) -> Option<&'a T> {
1815 #[stable(feature = "rust1", since = "1.0.0")]
1816 impl<T> ExactSizeIterator for Iter<'_, T> {}
1818 #[stable(feature = "fused", since = "1.26.0")]
1819 impl<T> FusedIterator for Iter<'_, T> {}
1821 #[unstable(feature = "trusted_len", issue = "37572")]
1822 unsafe impl<A> TrustedLen for Iter<'_, A> {}
1824 #[stable(feature = "rust1", since = "1.0.0")]
1825 impl<T> Clone for Iter<'_, T> {
1827 fn clone(&self) -> Self {
1828 Iter { inner: self.inner }
1832 /// An iterator over a mutable reference to the [`Ok`] variant of a [`Result`].
1834 /// Created by [`Result::iter_mut`].
1836 #[stable(feature = "rust1", since = "1.0.0")]
1837 pub struct IterMut<'a, T: 'a> {
1838 inner: Option<&'a mut T>,
1841 #[stable(feature = "rust1", since = "1.0.0")]
1842 impl<'a, T> Iterator for IterMut<'a, T> {
1843 type Item = &'a mut T;
1846 fn next(&mut self) -> Option<&'a mut T> {
1850 fn size_hint(&self) -> (usize, Option<usize>) {
1851 let n = if self.inner.is_some() { 1 } else { 0 };
1856 #[stable(feature = "rust1", since = "1.0.0")]
1857 impl<'a, T> DoubleEndedIterator for IterMut<'a, T> {
1859 fn next_back(&mut self) -> Option<&'a mut T> {
1864 #[stable(feature = "rust1", since = "1.0.0")]
1865 impl<T> ExactSizeIterator for IterMut<'_, T> {}
1867 #[stable(feature = "fused", since = "1.26.0")]
1868 impl<T> FusedIterator for IterMut<'_, T> {}
1870 #[unstable(feature = "trusted_len", issue = "37572")]
1871 unsafe impl<A> TrustedLen for IterMut<'_, A> {}
1873 /// An iterator over the value in a [`Ok`] variant of a [`Result`].
1875 /// The iterator yields one value if the result is [`Ok`], otherwise none.
1877 /// This struct is created by the [`into_iter`] method on
1878 /// [`Result`] (provided by the [`IntoIterator`] trait).
1880 /// [`into_iter`]: IntoIterator::into_iter
1881 #[derive(Clone, Debug)]
1882 #[stable(feature = "rust1", since = "1.0.0")]
1883 pub struct IntoIter<T> {
1887 #[stable(feature = "rust1", since = "1.0.0")]
1888 impl<T> Iterator for IntoIter<T> {
1892 fn next(&mut self) -> Option<T> {
1896 fn size_hint(&self) -> (usize, Option<usize>) {
1897 let n = if self.inner.is_some() { 1 } else { 0 };
1902 #[stable(feature = "rust1", since = "1.0.0")]
1903 impl<T> DoubleEndedIterator for IntoIter<T> {
1905 fn next_back(&mut self) -> Option<T> {
1910 #[stable(feature = "rust1", since = "1.0.0")]
1911 impl<T> ExactSizeIterator for IntoIter<T> {}
1913 #[stable(feature = "fused", since = "1.26.0")]
1914 impl<T> FusedIterator for IntoIter<T> {}
1916 #[unstable(feature = "trusted_len", issue = "37572")]
1917 unsafe impl<A> TrustedLen for IntoIter<A> {}
1919 /////////////////////////////////////////////////////////////////////////////
1921 /////////////////////////////////////////////////////////////////////////////
1923 #[stable(feature = "rust1", since = "1.0.0")]
1924 impl<A, E, V: FromIterator<A>> FromIterator<Result<A, E>> for Result<V, E> {
1925 /// Takes each element in the `Iterator`: if it is an `Err`, no further
1926 /// elements are taken, and the `Err` is returned. Should no `Err` occur, a
1927 /// container with the values of each `Result` is returned.
1929 /// Here is an example which increments every integer in a vector,
1930 /// checking for overflow:
1933 /// let v = vec![1, 2];
1934 /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
1935 /// x.checked_add(1).ok_or("Overflow!")
1937 /// assert_eq!(res, Ok(vec![2, 3]));
1940 /// Here is another example that tries to subtract one from another list
1941 /// of integers, this time checking for underflow:
1944 /// let v = vec![1, 2, 0];
1945 /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
1946 /// x.checked_sub(1).ok_or("Underflow!")
1948 /// assert_eq!(res, Err("Underflow!"));
1951 /// Here is a variation on the previous example, showing that no
1952 /// further elements are taken from `iter` after the first `Err`.
1955 /// let v = vec![3, 2, 1, 10];
1956 /// let mut shared = 0;
1957 /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {
1959 /// x.checked_sub(2).ok_or("Underflow!")
1961 /// assert_eq!(res, Err("Underflow!"));
1962 /// assert_eq!(shared, 6);
1965 /// Since the third element caused an underflow, no further elements were taken,
1966 /// so the final value of `shared` is 6 (= `3 + 2 + 1`), not 16.
1968 fn from_iter<I: IntoIterator<Item = Result<A, E>>>(iter: I) -> Result<V, E> {
1969 // FIXME(#11084): This could be replaced with Iterator::scan when this
1970 // performance bug is closed.
1972 iter::process_results(iter.into_iter(), |i| i.collect())
1976 #[unstable(feature = "try_trait_v2", issue = "84277")]
1977 #[rustc_const_unstable(feature = "const_convert", issue = "88674")]
1978 impl<T, E> const ops::Try for Result<T, E> {
1980 type Residual = Result<convert::Infallible, E>;
1983 fn from_output(output: Self::Output) -> Self {
1988 fn branch(self) -> ControlFlow<Self::Residual, Self::Output> {
1990 Ok(v) => ControlFlow::Continue(v),
1991 Err(e) => ControlFlow::Break(Err(e)),
1996 #[unstable(feature = "try_trait_v2", issue = "84277")]
1997 #[rustc_const_unstable(feature = "const_convert", issue = "88674")]
1998 impl<T, E, F: ~const From<E>> const ops::FromResidual<Result<convert::Infallible, E>>
2003 fn from_residual(residual: Result<convert::Infallible, E>) -> Self {
2005 Err(e) => Err(From::from(e)),
2010 #[unstable(feature = "try_trait_v2_residual", issue = "91285")]
2011 impl<T, E> ops::Residual<T> for Result<convert::Infallible, E> {
2012 type TryType = Result<T, E>;