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 /////////////////////////////////////////////////////////////////////////
858 // Iterator constructors
859 /////////////////////////////////////////////////////////////////////////
861 /// Returns an iterator over the possibly contained value.
863 /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
870 /// let x: Result<u32, &str> = Ok(7);
871 /// assert_eq!(x.iter().next(), Some(&7));
873 /// let x: Result<u32, &str> = Err("nothing!");
874 /// assert_eq!(x.iter().next(), None);
877 #[stable(feature = "rust1", since = "1.0.0")]
878 pub fn iter(&self) -> Iter<'_, T> {
879 Iter { inner: self.as_ref().ok() }
882 /// Returns a mutable iterator over the possibly contained value.
884 /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
891 /// let mut x: Result<u32, &str> = Ok(7);
892 /// match x.iter_mut().next() {
893 /// Some(v) => *v = 40,
896 /// assert_eq!(x, Ok(40));
898 /// let mut x: Result<u32, &str> = Err("nothing!");
899 /// assert_eq!(x.iter_mut().next(), None);
902 #[stable(feature = "rust1", since = "1.0.0")]
903 pub fn iter_mut(&mut self) -> IterMut<'_, T> {
904 IterMut { inner: self.as_mut().ok() }
907 ////////////////////////////////////////////////////////////////////////
908 // Boolean operations on the values, eager and lazy
909 /////////////////////////////////////////////////////////////////////////
911 /// Returns `res` if the result is [`Ok`], otherwise returns the [`Err`] value of `self`.
919 /// let x: Result<u32, &str> = Ok(2);
920 /// let y: Result<&str, &str> = Err("late error");
921 /// assert_eq!(x.and(y), Err("late error"));
923 /// let x: Result<u32, &str> = Err("early error");
924 /// let y: Result<&str, &str> = Ok("foo");
925 /// assert_eq!(x.and(y), Err("early error"));
927 /// let x: Result<u32, &str> = Err("not a 2");
928 /// let y: Result<&str, &str> = Err("late error");
929 /// assert_eq!(x.and(y), Err("not a 2"));
931 /// let x: Result<u32, &str> = Ok(2);
932 /// let y: Result<&str, &str> = Ok("different result type");
933 /// assert_eq!(x.and(y), Ok("different result type"));
936 #[stable(feature = "rust1", since = "1.0.0")]
937 pub fn and<U>(self, res: Result<U, E>) -> Result<U, E> {
944 /// Calls `op` if the result is [`Ok`], otherwise returns the [`Err`] value of `self`.
947 /// This function can be used for control flow based on `Result` values.
954 /// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
955 /// fn err(x: u32) -> Result<u32, u32> { Err(x) }
957 /// assert_eq!(Ok(2).and_then(sq).and_then(sq), Ok(16));
958 /// assert_eq!(Ok(2).and_then(sq).and_then(err), Err(4));
959 /// assert_eq!(Ok(2).and_then(err).and_then(sq), Err(2));
960 /// assert_eq!(Err(3).and_then(sq).and_then(sq), Err(3));
963 #[stable(feature = "rust1", since = "1.0.0")]
964 pub fn and_then<U, F: FnOnce(T) -> Result<U, E>>(self, op: F) -> Result<U, E> {
971 /// Returns `res` if the result is [`Err`], otherwise returns the [`Ok`] value of `self`.
973 /// Arguments passed to `or` are eagerly evaluated; if you are passing the
974 /// result of a function call, it is recommended to use [`or_else`], which is
975 /// lazily evaluated.
977 /// [`or_else`]: Result::or_else
984 /// let x: Result<u32, &str> = Ok(2);
985 /// let y: Result<u32, &str> = Err("late error");
986 /// assert_eq!(x.or(y), Ok(2));
988 /// let x: Result<u32, &str> = Err("early error");
989 /// let y: Result<u32, &str> = Ok(2);
990 /// assert_eq!(x.or(y), Ok(2));
992 /// let x: Result<u32, &str> = Err("not a 2");
993 /// let y: Result<u32, &str> = Err("late error");
994 /// assert_eq!(x.or(y), Err("late error"));
996 /// let x: Result<u32, &str> = Ok(2);
997 /// let y: Result<u32, &str> = Ok(100);
998 /// assert_eq!(x.or(y), Ok(2));
1001 #[stable(feature = "rust1", since = "1.0.0")]
1002 pub fn or<F>(self, res: Result<T, F>) -> Result<T, F> {
1009 /// Calls `op` if the result is [`Err`], otherwise returns the [`Ok`] value of `self`.
1011 /// This function can be used for control flow based on result values.
1019 /// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
1020 /// fn err(x: u32) -> Result<u32, u32> { Err(x) }
1022 /// assert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));
1023 /// assert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));
1024 /// assert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));
1025 /// assert_eq!(Err(3).or_else(err).or_else(err), Err(3));
1028 #[stable(feature = "rust1", since = "1.0.0")]
1029 pub fn or_else<F, O: FnOnce(E) -> Result<T, F>>(self, op: O) -> Result<T, F> {
1036 /// Returns the contained [`Ok`] value or a provided default.
1038 /// Arguments passed to `unwrap_or` are eagerly evaluated; if you are passing
1039 /// the result of a function call, it is recommended to use [`unwrap_or_else`],
1040 /// which is lazily evaluated.
1042 /// [`unwrap_or_else`]: Result::unwrap_or_else
1049 /// let default = 2;
1050 /// let x: Result<u32, &str> = Ok(9);
1051 /// assert_eq!(x.unwrap_or(default), 9);
1053 /// let x: Result<u32, &str> = Err("error");
1054 /// assert_eq!(x.unwrap_or(default), default);
1057 #[stable(feature = "rust1", since = "1.0.0")]
1058 pub fn unwrap_or(self, default: T) -> T {
1065 /// Returns the contained [`Ok`] value or computes it from a closure.
1073 /// fn count(x: &str) -> usize { x.len() }
1075 /// assert_eq!(Ok(2).unwrap_or_else(count), 2);
1076 /// assert_eq!(Err("foo").unwrap_or_else(count), 3);
1079 #[stable(feature = "rust1", since = "1.0.0")]
1080 pub fn unwrap_or_else<F: FnOnce(E) -> T>(self, op: F) -> T {
1087 /// Returns the contained [`Ok`] value, consuming the `self` value,
1088 /// without checking that the value is not an [`Err`].
1092 /// Calling this method on an [`Err`] is *[undefined behavior]*.
1094 /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
1099 /// let x: Result<u32, &str> = Ok(2);
1100 /// assert_eq!(unsafe { x.unwrap_unchecked() }, 2);
1104 /// let x: Result<u32, &str> = Err("emergency failure");
1105 /// unsafe { x.unwrap_unchecked(); } // Undefined behavior!
1109 #[stable(feature = "option_result_unwrap_unchecked", since = "1.58.0")]
1110 pub unsafe fn unwrap_unchecked(self) -> T {
1111 debug_assert!(self.is_ok());
1114 // SAFETY: the safety contract must be upheld by the caller.
1115 Err(_) => unsafe { hint::unreachable_unchecked() },
1119 /// Returns the contained [`Err`] value, consuming the `self` value,
1120 /// without checking that the value is not an [`Ok`].
1124 /// Calling this method on an [`Ok`] is *[undefined behavior]*.
1126 /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
1131 /// let x: Result<u32, &str> = Ok(2);
1132 /// unsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
1136 /// let x: Result<u32, &str> = Err("emergency failure");
1137 /// assert_eq!(unsafe { x.unwrap_err_unchecked() }, "emergency failure");
1141 #[stable(feature = "option_result_unwrap_unchecked", since = "1.58.0")]
1142 pub unsafe fn unwrap_err_unchecked(self) -> E {
1143 debug_assert!(self.is_err());
1145 // SAFETY: the safety contract must be upheld by the caller.
1146 Ok(_) => unsafe { hint::unreachable_unchecked() },
1152 impl<T: Copy, E> Result<&T, E> {
1153 /// Maps a `Result<&T, E>` to a `Result<T, E>` by copying the contents of the
1159 /// #![feature(result_copied)]
1161 /// let x: Result<&i32, i32> = Ok(&val);
1162 /// assert_eq!(x, Ok(&12));
1163 /// let copied = x.copied();
1164 /// assert_eq!(copied, Ok(12));
1166 #[unstable(feature = "result_copied", reason = "newly added", issue = "63168")]
1167 pub fn copied(self) -> Result<T, E> {
1172 impl<T: Copy, E> Result<&mut T, E> {
1173 /// Maps a `Result<&mut T, E>` to a `Result<T, E>` by copying the contents of the
1179 /// #![feature(result_copied)]
1180 /// let mut val = 12;
1181 /// let x: Result<&mut i32, i32> = Ok(&mut val);
1182 /// assert_eq!(x, Ok(&mut 12));
1183 /// let copied = x.copied();
1184 /// assert_eq!(copied, Ok(12));
1186 #[unstable(feature = "result_copied", reason = "newly added", issue = "63168")]
1187 pub fn copied(self) -> Result<T, E> {
1188 self.map(|&mut t| t)
1192 impl<T: Clone, E> Result<&T, E> {
1193 /// Maps a `Result<&T, E>` to a `Result<T, E>` by cloning the contents of the
1199 /// #![feature(result_cloned)]
1201 /// let x: Result<&i32, i32> = Ok(&val);
1202 /// assert_eq!(x, Ok(&12));
1203 /// let cloned = x.cloned();
1204 /// assert_eq!(cloned, Ok(12));
1206 #[unstable(feature = "result_cloned", reason = "newly added", issue = "63168")]
1207 pub fn cloned(self) -> Result<T, E> {
1208 self.map(|t| t.clone())
1212 impl<T: Clone, E> Result<&mut T, E> {
1213 /// Maps a `Result<&mut T, E>` to a `Result<T, E>` by cloning the contents of the
1219 /// #![feature(result_cloned)]
1220 /// let mut val = 12;
1221 /// let x: Result<&mut i32, i32> = Ok(&mut val);
1222 /// assert_eq!(x, Ok(&mut 12));
1223 /// let cloned = x.cloned();
1224 /// assert_eq!(cloned, Ok(12));
1226 #[unstable(feature = "result_cloned", reason = "newly added", issue = "63168")]
1227 pub fn cloned(self) -> Result<T, E> {
1228 self.map(|t| t.clone())
1232 impl<T, E: fmt::Debug> Result<T, E> {
1233 /// Returns the contained [`Ok`] value, consuming the `self` value.
1237 /// Panics if the value is an [`Err`], with a panic message including the
1238 /// passed message, and the content of the [`Err`].
1246 /// let x: Result<u32, &str> = Err("emergency failure");
1247 /// x.expect("Testing expect"); // panics with `Testing expect: emergency failure`
1251 #[stable(feature = "result_expect", since = "1.4.0")]
1252 pub fn expect(self, msg: &str) -> T {
1255 Err(e) => unwrap_failed(msg, &e),
1259 /// Returns the contained [`Ok`] value, consuming the `self` value.
1261 /// Because this function may panic, its use is generally discouraged.
1262 /// Instead, prefer to use pattern matching and handle the [`Err`]
1263 /// case explicitly, or call [`unwrap_or`], [`unwrap_or_else`], or
1264 /// [`unwrap_or_default`].
1266 /// [`unwrap_or`]: Result::unwrap_or
1267 /// [`unwrap_or_else`]: Result::unwrap_or_else
1268 /// [`unwrap_or_default`]: Result::unwrap_or_default
1272 /// Panics if the value is an [`Err`], with a panic message provided by the
1273 /// [`Err`]'s value.
1281 /// let x: Result<u32, &str> = Ok(2);
1282 /// assert_eq!(x.unwrap(), 2);
1286 /// let x: Result<u32, &str> = Err("emergency failure");
1287 /// x.unwrap(); // panics with `emergency failure`
1291 #[stable(feature = "rust1", since = "1.0.0")]
1292 pub fn unwrap(self) -> T {
1295 Err(e) => unwrap_failed("called `Result::unwrap()` on an `Err` value", &e),
1300 impl<T: fmt::Debug, E> Result<T, E> {
1301 /// Returns the contained [`Err`] value, consuming the `self` value.
1305 /// Panics if the value is an [`Ok`], with a panic message including the
1306 /// passed message, and the content of the [`Ok`].
1314 /// let x: Result<u32, &str> = Ok(10);
1315 /// x.expect_err("Testing expect_err"); // panics with `Testing expect_err: 10`
1319 #[stable(feature = "result_expect_err", since = "1.17.0")]
1320 pub fn expect_err(self, msg: &str) -> E {
1322 Ok(t) => unwrap_failed(msg, &t),
1327 /// Returns the contained [`Err`] value, consuming the `self` value.
1331 /// Panics if the value is an [`Ok`], with a custom panic message provided
1332 /// by the [`Ok`]'s value.
1337 /// let x: Result<u32, &str> = Ok(2);
1338 /// x.unwrap_err(); // panics with `2`
1342 /// let x: Result<u32, &str> = Err("emergency failure");
1343 /// assert_eq!(x.unwrap_err(), "emergency failure");
1347 #[stable(feature = "rust1", since = "1.0.0")]
1348 pub fn unwrap_err(self) -> E {
1350 Ok(t) => unwrap_failed("called `Result::unwrap_err()` on an `Ok` value", &t),
1356 impl<T: Default, E> Result<T, E> {
1357 /// Returns the contained [`Ok`] value or a default
1359 /// Consumes the `self` argument then, if [`Ok`], returns the contained
1360 /// value, otherwise if [`Err`], returns the default value for that
1365 /// Converts a string to an integer, turning poorly-formed strings
1366 /// into 0 (the default value for integers). [`parse`] converts
1367 /// a string to any other type that implements [`FromStr`], returning an
1368 /// [`Err`] on error.
1371 /// let good_year_from_input = "1909";
1372 /// let bad_year_from_input = "190blarg";
1373 /// let good_year = good_year_from_input.parse().unwrap_or_default();
1374 /// let bad_year = bad_year_from_input.parse().unwrap_or_default();
1376 /// assert_eq!(1909, good_year);
1377 /// assert_eq!(0, bad_year);
1380 /// [`parse`]: str::parse
1381 /// [`FromStr`]: crate::str::FromStr
1383 #[stable(feature = "result_unwrap_or_default", since = "1.16.0")]
1384 pub fn unwrap_or_default(self) -> T {
1387 Err(_) => Default::default(),
1392 #[unstable(feature = "unwrap_infallible", reason = "newly added", issue = "61695")]
1393 impl<T, E: Into<!>> Result<T, E> {
1394 /// Returns the contained [`Ok`] value, but never panics.
1396 /// Unlike [`unwrap`], this method is known to never panic on the
1397 /// result types it is implemented for. Therefore, it can be used
1398 /// instead of `unwrap` as a maintainability safeguard that will fail
1399 /// to compile if the error type of the `Result` is later changed
1400 /// to an error that can actually occur.
1402 /// [`unwrap`]: Result::unwrap
1409 /// # #![feature(never_type)]
1410 /// # #![feature(unwrap_infallible)]
1412 /// fn only_good_news() -> Result<String, !> {
1413 /// Ok("this is fine".into())
1416 /// let s: String = only_good_news().into_ok();
1417 /// println!("{}", s);
1420 pub fn into_ok(self) -> T {
1428 #[unstable(feature = "unwrap_infallible", reason = "newly added", issue = "61695")]
1429 impl<T: Into<!>, E> Result<T, E> {
1430 /// Returns the contained [`Err`] value, but never panics.
1432 /// Unlike [`unwrap_err`], this method is known to never panic on the
1433 /// result types it is implemented for. Therefore, it can be used
1434 /// instead of `unwrap_err` as a maintainability safeguard that will fail
1435 /// to compile if the ok type of the `Result` is later changed
1436 /// to a type that can actually occur.
1438 /// [`unwrap_err`]: Result::unwrap_err
1445 /// # #![feature(never_type)]
1446 /// # #![feature(unwrap_infallible)]
1448 /// fn only_bad_news() -> Result<!, String> {
1449 /// Err("Oops, it failed".into())
1452 /// let error: String = only_bad_news().into_err();
1453 /// println!("{}", error);
1456 pub fn into_err(self) -> E {
1464 impl<T: Deref, E> Result<T, E> {
1465 /// Converts from `Result<T, E>` (or `&Result<T, E>`) to `Result<&<T as Deref>::Target, &E>`.
1467 /// Coerces the [`Ok`] variant of the original [`Result`] via [`Deref`](crate::ops::Deref)
1468 /// and returns the new [`Result`].
1473 /// let x: Result<String, u32> = Ok("hello".to_string());
1474 /// let y: Result<&str, &u32> = Ok("hello");
1475 /// assert_eq!(x.as_deref(), y);
1477 /// let x: Result<String, u32> = Err(42);
1478 /// let y: Result<&str, &u32> = Err(&42);
1479 /// assert_eq!(x.as_deref(), y);
1481 #[stable(feature = "inner_deref", since = "1.47.0")]
1482 pub fn as_deref(&self) -> Result<&T::Target, &E> {
1483 self.as_ref().map(|t| t.deref())
1487 impl<T: DerefMut, E> Result<T, E> {
1488 /// Converts from `Result<T, E>` (or `&mut Result<T, E>`) to `Result<&mut <T as DerefMut>::Target, &mut E>`.
1490 /// Coerces the [`Ok`] variant of the original [`Result`] via [`DerefMut`](crate::ops::DerefMut)
1491 /// and returns the new [`Result`].
1496 /// let mut s = "HELLO".to_string();
1497 /// let mut x: Result<String, u32> = Ok("hello".to_string());
1498 /// let y: Result<&mut str, &mut u32> = Ok(&mut s);
1499 /// assert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
1502 /// let mut x: Result<String, u32> = Err(42);
1503 /// let y: Result<&mut str, &mut u32> = Err(&mut i);
1504 /// assert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
1506 #[stable(feature = "inner_deref", since = "1.47.0")]
1507 pub fn as_deref_mut(&mut self) -> Result<&mut T::Target, &mut E> {
1508 self.as_mut().map(|t| t.deref_mut())
1512 impl<T, E> Result<Option<T>, E> {
1513 /// Transposes a `Result` of an `Option` into an `Option` of a `Result`.
1515 /// `Ok(None)` will be mapped to `None`.
1516 /// `Ok(Some(_))` and `Err(_)` will be mapped to `Some(Ok(_))` and `Some(Err(_))`.
1521 /// #[derive(Debug, Eq, PartialEq)]
1524 /// let x: Result<Option<i32>, SomeErr> = Ok(Some(5));
1525 /// let y: Option<Result<i32, SomeErr>> = Some(Ok(5));
1526 /// assert_eq!(x.transpose(), y);
1529 #[stable(feature = "transpose_result", since = "1.33.0")]
1530 #[rustc_const_unstable(feature = "const_result", issue = "82814")]
1531 pub const fn transpose(self) -> Option<Result<T, E>> {
1533 Ok(Some(x)) => Some(Ok(x)),
1535 Err(e) => Some(Err(e)),
1540 impl<T, E> Result<Result<T, E>, E> {
1541 /// Converts from `Result<Result<T, E>, E>` to `Result<T, E>`
1548 /// #![feature(result_flattening)]
1549 /// let x: Result<Result<&'static str, u32>, u32> = Ok(Ok("hello"));
1550 /// assert_eq!(Ok("hello"), x.flatten());
1552 /// let x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));
1553 /// assert_eq!(Err(6), x.flatten());
1555 /// let x: Result<Result<&'static str, u32>, u32> = Err(6);
1556 /// assert_eq!(Err(6), x.flatten());
1559 /// Flattening only removes one level of nesting at a time:
1562 /// #![feature(result_flattening)]
1563 /// let x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok("hello")));
1564 /// assert_eq!(Ok(Ok("hello")), x.flatten());
1565 /// assert_eq!(Ok("hello"), x.flatten().flatten());
1568 #[unstable(feature = "result_flattening", issue = "70142")]
1569 pub fn flatten(self) -> Result<T, E> {
1570 self.and_then(convert::identity)
1574 impl<T> Result<T, T> {
1575 /// Returns the [`Ok`] value if `self` is `Ok`, and the [`Err`] value if
1576 /// `self` is `Err`.
1578 /// In other words, this function returns the value (the `T`) of a
1579 /// `Result<T, T>`, regardless of whether or not that result is `Ok` or
1582 /// This can be useful in conjunction with APIs such as
1583 /// [`Atomic*::compare_exchange`], or [`slice::binary_search`], but only in
1584 /// cases where you don't care if the result was `Ok` or not.
1586 /// [`Atomic*::compare_exchange`]: crate::sync::atomic::AtomicBool::compare_exchange
1591 /// #![feature(result_into_ok_or_err)]
1592 /// let ok: Result<u32, u32> = Ok(3);
1593 /// let err: Result<u32, u32> = Err(4);
1595 /// assert_eq!(ok.into_ok_or_err(), 3);
1596 /// assert_eq!(err.into_ok_or_err(), 4);
1599 #[unstable(feature = "result_into_ok_or_err", reason = "newly added", issue = "82223")]
1600 pub const fn into_ok_or_err(self) -> T {
1608 // This is a separate function to reduce the code size of the methods
1612 fn unwrap_failed(msg: &str, error: &dyn fmt::Debug) -> ! {
1613 panic!("{}: {:?}", msg, error)
1616 /////////////////////////////////////////////////////////////////////////////
1617 // Trait implementations
1618 /////////////////////////////////////////////////////////////////////////////
1620 #[stable(feature = "rust1", since = "1.0.0")]
1621 impl<T: Clone, E: Clone> Clone for Result<T, E> {
1623 fn clone(&self) -> Self {
1625 Ok(x) => Ok(x.clone()),
1626 Err(x) => Err(x.clone()),
1631 fn clone_from(&mut self, source: &Self) {
1632 match (self, source) {
1633 (Ok(to), Ok(from)) => to.clone_from(from),
1634 (Err(to), Err(from)) => to.clone_from(from),
1635 (to, from) => *to = from.clone(),
1640 #[stable(feature = "rust1", since = "1.0.0")]
1641 impl<T, E> IntoIterator for Result<T, E> {
1643 type IntoIter = IntoIter<T>;
1645 /// Returns a consuming iterator over the possibly contained value.
1647 /// The iterator yields one value if the result is [`Result::Ok`], otherwise none.
1654 /// let x: Result<u32, &str> = Ok(5);
1655 /// let v: Vec<u32> = x.into_iter().collect();
1656 /// assert_eq!(v, [5]);
1658 /// let x: Result<u32, &str> = Err("nothing!");
1659 /// let v: Vec<u32> = x.into_iter().collect();
1660 /// assert_eq!(v, []);
1663 fn into_iter(self) -> IntoIter<T> {
1664 IntoIter { inner: self.ok() }
1668 #[stable(since = "1.4.0", feature = "result_iter")]
1669 impl<'a, T, E> IntoIterator for &'a Result<T, E> {
1671 type IntoIter = Iter<'a, T>;
1673 fn into_iter(self) -> Iter<'a, T> {
1678 #[stable(since = "1.4.0", feature = "result_iter")]
1679 impl<'a, T, E> IntoIterator for &'a mut Result<T, E> {
1680 type Item = &'a mut T;
1681 type IntoIter = IterMut<'a, T>;
1683 fn into_iter(self) -> IterMut<'a, T> {
1688 /////////////////////////////////////////////////////////////////////////////
1689 // The Result Iterators
1690 /////////////////////////////////////////////////////////////////////////////
1692 /// An iterator over a reference to the [`Ok`] variant of a [`Result`].
1694 /// The iterator yields one value if the result is [`Ok`], otherwise none.
1696 /// Created by [`Result::iter`].
1698 #[stable(feature = "rust1", since = "1.0.0")]
1699 pub struct Iter<'a, T: 'a> {
1700 inner: Option<&'a T>,
1703 #[stable(feature = "rust1", since = "1.0.0")]
1704 impl<'a, T> Iterator for Iter<'a, T> {
1708 fn next(&mut self) -> Option<&'a T> {
1712 fn size_hint(&self) -> (usize, Option<usize>) {
1713 let n = if self.inner.is_some() { 1 } else { 0 };
1718 #[stable(feature = "rust1", since = "1.0.0")]
1719 impl<'a, T> DoubleEndedIterator for Iter<'a, T> {
1721 fn next_back(&mut self) -> Option<&'a T> {
1726 #[stable(feature = "rust1", since = "1.0.0")]
1727 impl<T> ExactSizeIterator for Iter<'_, T> {}
1729 #[stable(feature = "fused", since = "1.26.0")]
1730 impl<T> FusedIterator for Iter<'_, T> {}
1732 #[unstable(feature = "trusted_len", issue = "37572")]
1733 unsafe impl<A> TrustedLen for Iter<'_, A> {}
1735 #[stable(feature = "rust1", since = "1.0.0")]
1736 impl<T> Clone for Iter<'_, T> {
1738 fn clone(&self) -> Self {
1739 Iter { inner: self.inner }
1743 /// An iterator over a mutable reference to the [`Ok`] variant of a [`Result`].
1745 /// Created by [`Result::iter_mut`].
1747 #[stable(feature = "rust1", since = "1.0.0")]
1748 pub struct IterMut<'a, T: 'a> {
1749 inner: Option<&'a mut T>,
1752 #[stable(feature = "rust1", since = "1.0.0")]
1753 impl<'a, T> Iterator for IterMut<'a, T> {
1754 type Item = &'a mut T;
1757 fn next(&mut self) -> Option<&'a mut T> {
1761 fn size_hint(&self) -> (usize, Option<usize>) {
1762 let n = if self.inner.is_some() { 1 } else { 0 };
1767 #[stable(feature = "rust1", since = "1.0.0")]
1768 impl<'a, T> DoubleEndedIterator for IterMut<'a, T> {
1770 fn next_back(&mut self) -> Option<&'a mut T> {
1775 #[stable(feature = "rust1", since = "1.0.0")]
1776 impl<T> ExactSizeIterator for IterMut<'_, T> {}
1778 #[stable(feature = "fused", since = "1.26.0")]
1779 impl<T> FusedIterator for IterMut<'_, T> {}
1781 #[unstable(feature = "trusted_len", issue = "37572")]
1782 unsafe impl<A> TrustedLen for IterMut<'_, A> {}
1784 /// An iterator over the value in a [`Ok`] variant of a [`Result`].
1786 /// The iterator yields one value if the result is [`Ok`], otherwise none.
1788 /// This struct is created by the [`into_iter`] method on
1789 /// [`Result`] (provided by the [`IntoIterator`] trait).
1791 /// [`into_iter`]: IntoIterator::into_iter
1792 #[derive(Clone, Debug)]
1793 #[stable(feature = "rust1", since = "1.0.0")]
1794 pub struct IntoIter<T> {
1798 #[stable(feature = "rust1", since = "1.0.0")]
1799 impl<T> Iterator for IntoIter<T> {
1803 fn next(&mut self) -> Option<T> {
1807 fn size_hint(&self) -> (usize, Option<usize>) {
1808 let n = if self.inner.is_some() { 1 } else { 0 };
1813 #[stable(feature = "rust1", since = "1.0.0")]
1814 impl<T> DoubleEndedIterator for IntoIter<T> {
1816 fn next_back(&mut self) -> Option<T> {
1821 #[stable(feature = "rust1", since = "1.0.0")]
1822 impl<T> ExactSizeIterator for IntoIter<T> {}
1824 #[stable(feature = "fused", since = "1.26.0")]
1825 impl<T> FusedIterator for IntoIter<T> {}
1827 #[unstable(feature = "trusted_len", issue = "37572")]
1828 unsafe impl<A> TrustedLen for IntoIter<A> {}
1830 /////////////////////////////////////////////////////////////////////////////
1832 /////////////////////////////////////////////////////////////////////////////
1834 #[stable(feature = "rust1", since = "1.0.0")]
1835 impl<A, E, V: FromIterator<A>> FromIterator<Result<A, E>> for Result<V, E> {
1836 /// Takes each element in the `Iterator`: if it is an `Err`, no further
1837 /// elements are taken, and the `Err` is returned. Should no `Err` occur, a
1838 /// container with the values of each `Result` is returned.
1840 /// Here is an example which increments every integer in a vector,
1841 /// checking for overflow:
1844 /// let v = vec![1, 2];
1845 /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
1846 /// x.checked_add(1).ok_or("Overflow!")
1848 /// assert_eq!(res, Ok(vec![2, 3]));
1851 /// Here is another example that tries to subtract one from another list
1852 /// of integers, this time checking for underflow:
1855 /// let v = vec![1, 2, 0];
1856 /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
1857 /// x.checked_sub(1).ok_or("Underflow!")
1859 /// assert_eq!(res, Err("Underflow!"));
1862 /// Here is a variation on the previous example, showing that no
1863 /// further elements are taken from `iter` after the first `Err`.
1866 /// let v = vec![3, 2, 1, 10];
1867 /// let mut shared = 0;
1868 /// let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {
1870 /// x.checked_sub(2).ok_or("Underflow!")
1872 /// assert_eq!(res, Err("Underflow!"));
1873 /// assert_eq!(shared, 6);
1876 /// Since the third element caused an underflow, no further elements were taken,
1877 /// so the final value of `shared` is 6 (= `3 + 2 + 1`), not 16.
1879 fn from_iter<I: IntoIterator<Item = Result<A, E>>>(iter: I) -> Result<V, E> {
1880 // FIXME(#11084): This could be replaced with Iterator::scan when this
1881 // performance bug is closed.
1883 iter::process_results(iter.into_iter(), |i| i.collect())
1887 #[unstable(feature = "try_trait_v2", issue = "84277")]
1888 impl<T, E> ops::Try for Result<T, E> {
1890 type Residual = Result<convert::Infallible, E>;
1893 fn from_output(output: Self::Output) -> Self {
1898 fn branch(self) -> ControlFlow<Self::Residual, Self::Output> {
1900 Ok(v) => ControlFlow::Continue(v),
1901 Err(e) => ControlFlow::Break(Err(e)),
1906 #[unstable(feature = "try_trait_v2", issue = "84277")]
1907 impl<T, E, F: From<E>> ops::FromResidual<Result<convert::Infallible, E>> for Result<T, F> {
1909 fn from_residual(residual: Result<convert::Infallible, E>) -> Self {
1911 Err(e) => Err(From::from(e)),