pub enum Result<T, E> {
Ok(T),
Err(E),
}
Expand description
Variants§
Implementations§
Source§impl<T, E> Result<T, E>
impl<T, E> Result<T, E>
1.0.0 (const: 1.48.0) · Sourcepub const fn is_ok(&self) -> bool
Available on crate feature error
only.
pub const fn is_ok(&self) -> bool
error
only.1.70.0 · Sourcepub fn is_ok_and(self, f: impl FnOnce(T) -> bool) -> bool
Available on crate feature error
only.
pub fn is_ok_and(self, f: impl FnOnce(T) -> bool) -> bool
error
only.Returns true
if the result is Ok
and the value inside of it matches a predicate.
§Examples
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.is_ok_and(|x| x > 1), true);
let x: Result<u32, &str> = Ok(0);
assert_eq!(x.is_ok_and(|x| x > 1), false);
let x: Result<u32, &str> = Err("hey");
assert_eq!(x.is_ok_and(|x| x > 1), false);
let x: Result<String, &str> = Ok("ownership".to_string());
assert_eq!(x.as_ref().is_ok_and(|x| x.len() > 1), true);
println!("still alive {:?}", x);
1.0.0 (const: 1.48.0) · Sourcepub const fn is_err(&self) -> bool
Available on crate feature error
only.
pub const fn is_err(&self) -> bool
error
only.1.70.0 · Sourcepub fn is_err_and(self, f: impl FnOnce(E) -> bool) -> bool
Available on crate feature error
only.
pub fn is_err_and(self, f: impl FnOnce(E) -> bool) -> bool
error
only.Returns true
if the result is Err
and the value inside of it matches a predicate.
§Examples
use std::io::{Error, ErrorKind};
let x: Result<u32, Error> = Err(Error::new(ErrorKind::NotFound, "!"));
assert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), true);
let x: Result<u32, Error> = Err(Error::new(ErrorKind::PermissionDenied, "!"));
assert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);
let x: Result<u32, Error> = Ok(123);
assert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);
let x: Result<u32, String> = Err("ownership".to_string());
assert_eq!(x.as_ref().is_err_and(|x| x.len() > 1), true);
println!("still alive {:?}", x);
1.0.0 (const: 1.48.0) · Sourcepub const fn as_ref(&self) -> Result<&T, &E> ⓘ
Available on crate feature error
only.
pub const fn as_ref(&self) -> Result<&T, &E> ⓘ
error
only.Converts from &Result<T, E>
to Result<&T, &E>
.
Produces a new Result
, containing a reference
into the original, leaving the original in place.
§Examples
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.as_ref(), Ok(&2));
let x: Result<u32, &str> = Err("Error");
assert_eq!(x.as_ref(), Err(&"Error"));
1.0.0 (const: 1.83.0) · Sourcepub const fn as_mut(&mut self) -> Result<&mut T, &mut E> ⓘ
Available on crate feature error
only.
pub const fn as_mut(&mut self) -> Result<&mut T, &mut E> ⓘ
error
only.Converts from &mut Result<T, E>
to Result<&mut T, &mut E>
.
§Examples
fn mutate(r: &mut Result<i32, i32>) {
match r.as_mut() {
Ok(v) => *v = 42,
Err(e) => *e = 0,
}
}
let mut x: Result<i32, i32> = Ok(2);
mutate(&mut x);
assert_eq!(x.unwrap(), 42);
let mut x: Result<i32, i32> = Err(13);
mutate(&mut x);
assert_eq!(x.unwrap_err(), 0);
1.0.0 · Sourcepub fn map<U, F>(self, op: F) -> Result<U, E> ⓘwhere
F: FnOnce(T) -> U,
Available on crate feature error
only.
pub fn map<U, F>(self, op: F) -> Result<U, E> ⓘwhere
F: FnOnce(T) -> U,
error
only.Maps a Result<T, E>
to Result<U, E>
by applying a function to a
contained Ok
value, leaving an Err
value untouched.
This function can be used to compose the results of two functions.
§Examples
Print the numbers on each line of a string multiplied by two.
let line = "1\n2\n3\n4\n";
for num in line.lines() {
match num.parse::<i32>().map(|i| i * 2) {
Ok(n) => println!("{n}"),
Err(..) => {}
}
}
1.41.0 · Sourcepub fn map_or<U, F>(self, default: U, f: F) -> Uwhere
F: FnOnce(T) -> U,
Available on crate feature error
only.
pub fn map_or<U, F>(self, default: U, f: F) -> Uwhere
F: FnOnce(T) -> U,
error
only.Returns the provided default (if Err
), or
applies a function to the contained value (if Ok
).
Arguments passed to map_or
are eagerly evaluated; if you are passing
the result of a function call, it is recommended to use map_or_else
,
which is lazily evaluated.
§Examples
let x: Result<_, &str> = Ok("foo");
assert_eq!(x.map_or(42, |v| v.len()), 3);
let x: Result<&str, _> = Err("bar");
assert_eq!(x.map_or(42, |v| v.len()), 42);
1.41.0 · Sourcepub fn map_or_else<U, D, F>(self, default: D, f: F) -> U
Available on crate feature error
only.
pub fn map_or_else<U, D, F>(self, default: D, f: F) -> U
error
only.Maps a Result<T, E>
to U
by applying fallback function default
to
a contained Err
value, or function f
to a contained Ok
value.
This function can be used to unpack a successful result while handling an error.
§Examples
let k = 21;
let x : Result<_, &str> = Ok("foo");
assert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);
let x : Result<&str, _> = Err("bar");
assert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
Sourcepub fn map_or_default<U, F>(self, f: F) -> U
🔬This is a nightly-only experimental API. (result_option_map_or_default
)Available on crate feature error
only.
pub fn map_or_default<U, F>(self, f: F) -> U
result_option_map_or_default
)error
only.Maps a Result<T, E>
to a U
by applying function f
to the contained
value if the result is Ok
, otherwise if Err
, returns the
default value for the type U
.
§Examples
#![feature(result_option_map_or_default)]
let x: Result<_, &str> = Ok("foo");
let y: Result<&str, _> = Err("bar");
assert_eq!(x.map_or_default(|x| x.len()), 3);
assert_eq!(y.map_or_default(|y| y.len()), 0);
1.0.0 · Sourcepub fn map_err<F, O>(self, op: O) -> Result<T, F> ⓘwhere
O: FnOnce(E) -> F,
Available on crate feature error
only.
pub fn map_err<F, O>(self, op: O) -> Result<T, F> ⓘwhere
O: FnOnce(E) -> F,
error
only.Maps a Result<T, E>
to Result<T, F>
by applying a function to a
contained Err
value, leaving an Ok
value untouched.
This function can be used to pass through a successful result while handling an error.
§Examples
fn stringify(x: u32) -> String { format!("error code: {x}") }
let x: Result<u32, u32> = Ok(2);
assert_eq!(x.map_err(stringify), Ok(2));
let x: Result<u32, u32> = Err(13);
assert_eq!(x.map_err(stringify), Err("error code: 13".to_string()));
1.76.0 · Sourcepub fn inspect<F>(self, f: F) -> Result<T, E> ⓘ
Available on crate feature error
only.
pub fn inspect<F>(self, f: F) -> Result<T, E> ⓘ
error
only.1.76.0 · Sourcepub fn inspect_err<F>(self, f: F) -> Result<T, E> ⓘ
Available on crate feature error
only.
pub fn inspect_err<F>(self, f: F) -> Result<T, E> ⓘ
error
only.1.47.0 · Sourcepub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E> ⓘwhere
T: Deref,
Available on crate feature error
only.
pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E> ⓘwhere
T: Deref,
error
only.Converts from Result<T, E>
(or &Result<T, E>
) to Result<&<T as Deref>::Target, &E>
.
Coerces the Ok
variant of the original Result
via Deref
and returns the new Result
.
§Examples
let x: Result<String, u32> = Ok("hello".to_string());
let y: Result<&str, &u32> = Ok("hello");
assert_eq!(x.as_deref(), y);
let x: Result<String, u32> = Err(42);
let y: Result<&str, &u32> = Err(&42);
assert_eq!(x.as_deref(), y);
1.47.0 · Sourcepub fn as_deref_mut(&mut self) -> Result<&mut <T as Deref>::Target, &mut E> ⓘwhere
T: DerefMut,
Available on crate feature error
only.
pub fn as_deref_mut(&mut self) -> Result<&mut <T as Deref>::Target, &mut E> ⓘwhere
T: DerefMut,
error
only.Converts from Result<T, E>
(or &mut Result<T, E>
) to Result<&mut <T as DerefMut>::Target, &mut E>
.
Coerces the Ok
variant of the original Result
via DerefMut
and returns the new Result
.
§Examples
let mut s = "HELLO".to_string();
let mut x: Result<String, u32> = Ok("hello".to_string());
let y: Result<&mut str, &mut u32> = Ok(&mut s);
assert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
let mut i = 42;
let mut x: Result<String, u32> = Err(42);
let y: Result<&mut str, &mut u32> = Err(&mut i);
assert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
1.0.0 · Sourcepub fn iter(&self) -> Iter<'_, T> ⓘ
Available on crate feature error
only.
pub fn iter(&self) -> Iter<'_, T> ⓘ
error
only.Returns an iterator over the possibly contained value.
The iterator yields one value if the result is Result::Ok
, otherwise none.
§Examples
let x: Result<u32, &str> = Ok(7);
assert_eq!(x.iter().next(), Some(&7));
let x: Result<u32, &str> = Err("nothing!");
assert_eq!(x.iter().next(), None);
1.0.0 · Sourcepub fn iter_mut(&mut self) -> IterMut<'_, T> ⓘ
Available on crate feature error
only.
pub fn iter_mut(&mut self) -> IterMut<'_, T> ⓘ
error
only.Returns a mutable iterator over the possibly contained value.
The iterator yields one value if the result is Result::Ok
, otherwise none.
§Examples
let mut x: Result<u32, &str> = Ok(7);
match x.iter_mut().next() {
Some(v) => *v = 40,
None => {},
}
assert_eq!(x, Ok(40));
let mut x: Result<u32, &str> = Err("nothing!");
assert_eq!(x.iter_mut().next(), None);
1.4.0 · Sourcepub fn expect(self, msg: &str) -> Twhere
E: Debug,
Available on crate feature error
only.
pub fn expect(self, msg: &str) -> Twhere
E: Debug,
error
only.Returns the contained Ok
value, consuming the self
value.
Because this function may panic, its use is generally discouraged.
Instead, prefer to use pattern matching and handle the Err
case explicitly, or call unwrap_or
, unwrap_or_else
, or
unwrap_or_default
.
§Panics
Panics if the value is an Err
, with a panic message including the
passed message, and the content of the Err
.
§Examples
let x: Result<u32, &str> = Err("emergency failure");
x.expect("Testing expect"); // panics with `Testing expect: emergency failure`
§Recommended Message Style
We recommend that expect
messages are used to describe the reason you
expect the Result
should be Ok
.
let path = std::env::var("IMPORTANT_PATH")
.expect("env variable `IMPORTANT_PATH` should be set by `wrapper_script.sh`");
Hint: If you’re having trouble remembering how to phrase expect error messages remember to focus on the word “should” as in “env variable should be set by blah” or “the given binary should be available and executable by the current user”.
For more detail on expect message styles and the reasoning behind our recommendation please
refer to the section on “Common Message
Styles” in the
std::error
module docs.
1.0.0 · Sourcepub fn unwrap(self) -> Twhere
E: Debug,
Available on crate feature error
only.
pub fn unwrap(self) -> Twhere
E: Debug,
error
only.Returns the contained Ok
value, consuming the self
value.
Because this function may panic, its use is generally discouraged. Panics are meant for unrecoverable errors, and may abort the entire program.
Instead, prefer to use the ?
(try) operator, or pattern matching
to handle the Err
case explicitly, or call unwrap_or
,
unwrap_or_else
, or unwrap_or_default
.
§Panics
Panics if the value is an Err
, with a panic message provided by the
Err
’s value.
§Examples
Basic usage:
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.unwrap(), 2);
let x: Result<u32, &str> = Err("emergency failure");
x.unwrap(); // panics with `emergency failure`
1.16.0 · Sourcepub fn unwrap_or_default(self) -> Twhere
T: Default,
Available on crate feature error
only.
pub fn unwrap_or_default(self) -> Twhere
T: Default,
error
only.Returns the contained Ok
value or a default
Consumes the self
argument then, if Ok
, returns the contained
value, otherwise if Err
, returns the default value for that
type.
§Examples
Converts a string to an integer, turning poorly-formed strings
into 0 (the default value for integers). parse
converts
a string to any other type that implements FromStr
, returning an
Err
on error.
let good_year_from_input = "1909";
let bad_year_from_input = "190blarg";
let good_year = good_year_from_input.parse().unwrap_or_default();
let bad_year = bad_year_from_input.parse().unwrap_or_default();
assert_eq!(1909, good_year);
assert_eq!(0, bad_year);
1.17.0 · Sourcepub fn expect_err(self, msg: &str) -> Ewhere
T: Debug,
Available on crate feature error
only.
pub fn expect_err(self, msg: &str) -> Ewhere
T: Debug,
error
only.1.0.0 · Sourcepub fn unwrap_err(self) -> Ewhere
T: Debug,
Available on crate feature error
only.
pub fn unwrap_err(self) -> Ewhere
T: Debug,
error
only.Returns the contained Err
value, consuming the self
value.
§Panics
Panics if the value is an Ok
, with a custom panic message provided
by the Ok
’s value.
§Examples
let x: Result<u32, &str> = Ok(2);
x.unwrap_err(); // panics with `2`
let x: Result<u32, &str> = Err("emergency failure");
assert_eq!(x.unwrap_err(), "emergency failure");
Sourcepub const fn into_ok(self) -> T
🔬This is a nightly-only experimental API. (unwrap_infallible
)Available on crate feature error
only.
pub const fn into_ok(self) -> T
unwrap_infallible
)error
only.Returns the contained Ok
value, but never panics.
Unlike unwrap
, this method is known to never panic on the
result types it is implemented for. Therefore, it can be used
instead of unwrap
as a maintainability safeguard that will fail
to compile if the error type of the Result
is later changed
to an error that can actually occur.
§Examples
fn only_good_news() -> Result<String, !> {
Ok("this is fine".into())
}
let s: String = only_good_news().into_ok();
println!("{s}");
Sourcepub const fn into_err(self) -> E
🔬This is a nightly-only experimental API. (unwrap_infallible
)Available on crate feature error
only.
pub const fn into_err(self) -> E
unwrap_infallible
)error
only.Returns the contained Err
value, but never panics.
Unlike unwrap_err
, this method is known to never panic on the
result types it is implemented for. Therefore, it can be used
instead of unwrap_err
as a maintainability safeguard that will fail
to compile if the ok type of the Result
is later changed
to a type that can actually occur.
§Examples
fn only_bad_news() -> Result<!, String> {
Err("Oops, it failed".into())
}
let error: String = only_bad_news().into_err();
println!("{error}");
1.0.0 · Sourcepub fn and<U>(self, res: Result<U, E>) -> Result<U, E> ⓘ
Available on crate feature error
only.
pub fn and<U>(self, res: Result<U, E>) -> Result<U, E> ⓘ
error
only.Returns res
if the result is Ok
, otherwise returns the Err
value of self
.
Arguments passed to and
are eagerly evaluated; if you are passing the
result of a function call, it is recommended to use and_then
, which is
lazily evaluated.
§Examples
let x: Result<u32, &str> = Ok(2);
let y: Result<&str, &str> = Err("late error");
assert_eq!(x.and(y), Err("late error"));
let x: Result<u32, &str> = Err("early error");
let y: Result<&str, &str> = Ok("foo");
assert_eq!(x.and(y), Err("early error"));
let x: Result<u32, &str> = Err("not a 2");
let y: Result<&str, &str> = Err("late error");
assert_eq!(x.and(y), Err("not a 2"));
let x: Result<u32, &str> = Ok(2);
let y: Result<&str, &str> = Ok("different result type");
assert_eq!(x.and(y), Ok("different result type"));
1.0.0 · Sourcepub fn and_then<U, F>(self, op: F) -> Result<U, E> ⓘ
Available on crate feature error
only.
pub fn and_then<U, F>(self, op: F) -> Result<U, E> ⓘ
error
only.Calls op
if the result is Ok
, otherwise returns the Err
value of self
.
This function can be used for control flow based on Result
values.
§Examples
fn sq_then_to_string(x: u32) -> Result<String, &'static str> {
x.checked_mul(x).map(|sq| sq.to_string()).ok_or("overflowed")
}
assert_eq!(Ok(2).and_then(sq_then_to_string), Ok(4.to_string()));
assert_eq!(Ok(1_000_000).and_then(sq_then_to_string), Err("overflowed"));
assert_eq!(Err("not a number").and_then(sq_then_to_string), Err("not a number"));
Often used to chain fallible operations that may return Err
.
use std::{io::ErrorKind, path::Path};
// Note: on Windows "/" maps to "C:\"
let root_modified_time = Path::new("/").metadata().and_then(|md| md.modified());
assert!(root_modified_time.is_ok());
let should_fail = Path::new("/bad/path").metadata().and_then(|md| md.modified());
assert!(should_fail.is_err());
assert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
1.0.0 · Sourcepub fn or<F>(self, res: Result<T, F>) -> Result<T, F> ⓘ
Available on crate feature error
only.
pub fn or<F>(self, res: Result<T, F>) -> Result<T, F> ⓘ
error
only.Returns res
if the result is Err
, otherwise returns the Ok
value of self
.
Arguments passed to or
are eagerly evaluated; if you are passing the
result of a function call, it is recommended to use or_else
, which is
lazily evaluated.
§Examples
let x: Result<u32, &str> = Ok(2);
let y: Result<u32, &str> = Err("late error");
assert_eq!(x.or(y), Ok(2));
let x: Result<u32, &str> = Err("early error");
let y: Result<u32, &str> = Ok(2);
assert_eq!(x.or(y), Ok(2));
let x: Result<u32, &str> = Err("not a 2");
let y: Result<u32, &str> = Err("late error");
assert_eq!(x.or(y), Err("late error"));
let x: Result<u32, &str> = Ok(2);
let y: Result<u32, &str> = Ok(100);
assert_eq!(x.or(y), Ok(2));
1.0.0 · Sourcepub fn or_else<F, O>(self, op: O) -> Result<T, F> ⓘ
Available on crate feature error
only.
pub fn or_else<F, O>(self, op: O) -> Result<T, F> ⓘ
error
only.Calls op
if the result is Err
, otherwise returns the Ok
value of self
.
This function can be used for control flow based on result values.
§Examples
fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
fn err(x: u32) -> Result<u32, u32> { Err(x) }
assert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));
assert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));
assert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));
assert_eq!(Err(3).or_else(err).or_else(err), Err(3));
1.0.0 · Sourcepub fn unwrap_or(self, default: T) -> T
Available on crate feature error
only.
pub fn unwrap_or(self, default: T) -> T
error
only.Returns the contained Ok
value or a provided default.
Arguments passed to unwrap_or
are eagerly evaluated; if you are passing
the result of a function call, it is recommended to use unwrap_or_else
,
which is lazily evaluated.
§Examples
let default = 2;
let x: Result<u32, &str> = Ok(9);
assert_eq!(x.unwrap_or(default), 9);
let x: Result<u32, &str> = Err("error");
assert_eq!(x.unwrap_or(default), default);
1.0.0 · Sourcepub fn unwrap_or_else<F>(self, op: F) -> Twhere
F: FnOnce(E) -> T,
Available on crate feature error
only.
pub fn unwrap_or_else<F>(self, op: F) -> Twhere
F: FnOnce(E) -> T,
error
only.1.58.0 · Sourcepub unsafe fn unwrap_unchecked(self) -> T
Available on crate feature error
only.
pub unsafe fn unwrap_unchecked(self) -> T
error
only.Returns the contained Ok
value, consuming the self
value,
without checking that the value is not an Err
.
§Safety
Calling this method on an Err
is undefined behavior.
§Examples
let x: Result<u32, &str> = Ok(2);
assert_eq!(unsafe { x.unwrap_unchecked() }, 2);
let x: Result<u32, &str> = Err("emergency failure");
unsafe { x.unwrap_unchecked(); } // Undefined behavior!
1.58.0 · Sourcepub unsafe fn unwrap_err_unchecked(self) -> E
Available on crate feature error
only.
pub unsafe fn unwrap_err_unchecked(self) -> E
error
only.Returns the contained Err
value, consuming the self
value,
without checking that the value is not an Ok
.
§Safety
Calling this method on an Ok
is undefined behavior.
§Examples
let x: Result<u32, &str> = Ok(2);
unsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
let x: Result<u32, &str> = Err("emergency failure");
assert_eq!(unsafe { x.unwrap_err_unchecked() }, "emergency failure");
Source§impl<T, E> Result<&T, E>
impl<T, E> Result<&T, E>
1.59.0 (const: 1.83.0) · Sourcepub const fn copied(self) -> Result<T, E> ⓘwhere
T: Copy,
Available on crate feature error
only.
pub const fn copied(self) -> Result<T, E> ⓘwhere
T: Copy,
error
only.Maps a Result<&T, E>
to a Result<T, E>
by copying the contents of the
Ok
part.
§Examples
let val = 12;
let x: Result<&i32, i32> = Ok(&val);
assert_eq!(x, Ok(&12));
let copied = x.copied();
assert_eq!(copied, Ok(12));
1.59.0 · Sourcepub fn cloned(self) -> Result<T, E> ⓘwhere
T: Clone,
Available on crate feature error
only.
pub fn cloned(self) -> Result<T, E> ⓘwhere
T: Clone,
error
only.Maps a Result<&T, E>
to a Result<T, E>
by cloning the contents of the
Ok
part.
§Examples
let val = 12;
let x: Result<&i32, i32> = Ok(&val);
assert_eq!(x, Ok(&12));
let cloned = x.cloned();
assert_eq!(cloned, Ok(12));
Source§impl<T, E> Result<&mut T, E>
impl<T, E> Result<&mut T, E>
1.59.0 (const: 1.83.0) · Sourcepub const fn copied(self) -> Result<T, E> ⓘwhere
T: Copy,
Available on crate feature error
only.
pub const fn copied(self) -> Result<T, E> ⓘwhere
T: Copy,
error
only.Maps a Result<&mut T, E>
to a Result<T, E>
by copying the contents of the
Ok
part.
§Examples
let mut val = 12;
let x: Result<&mut i32, i32> = Ok(&mut val);
assert_eq!(x, Ok(&mut 12));
let copied = x.copied();
assert_eq!(copied, Ok(12));
1.59.0 · Sourcepub fn cloned(self) -> Result<T, E> ⓘwhere
T: Clone,
Available on crate feature error
only.
pub fn cloned(self) -> Result<T, E> ⓘwhere
T: Clone,
error
only.Maps a Result<&mut T, E>
to a Result<T, E>
by cloning the contents of the
Ok
part.
§Examples
let mut val = 12;
let x: Result<&mut i32, i32> = Ok(&mut val);
assert_eq!(x, Ok(&mut 12));
let cloned = x.cloned();
assert_eq!(cloned, Ok(12));
Source§impl<T, E> Result<Option<T>, E>
impl<T, E> Result<Option<T>, E>
1.33.0 (const: 1.83.0) · Sourcepub const fn transpose(self) -> Option<Result<T, E>> ⓘ
Available on crate feature error
only.
pub const fn transpose(self) -> Option<Result<T, E>> ⓘ
error
only.Transposes a Result
of an Option
into an Option
of a Result
.
Ok(None)
will be mapped to None
.
Ok(Some(_))
and Err(_)
will be mapped to Some(Ok(_))
and Some(Err(_))
.
§Examples
#[derive(Debug, Eq, PartialEq)]
struct SomeErr;
let x: Result<Option<i32>, SomeErr> = Ok(Some(5));
let y: Option<Result<i32, SomeErr>> = Some(Ok(5));
assert_eq!(x.transpose(), y);
Source§impl<T, E> Result<Result<T, E>, E>
impl<T, E> Result<Result<T, E>, E>
1.89.0 (const: 1.89.0) · Sourcepub const fn flatten(self) -> Result<T, E> ⓘ
Available on crate feature error
only.
pub const fn flatten(self) -> Result<T, E> ⓘ
error
only.Converts from Result<Result<T, E>, E>
to Result<T, E>
§Examples
let x: Result<Result<&'static str, u32>, u32> = Ok(Ok("hello"));
assert_eq!(Ok("hello"), x.flatten());
let x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));
assert_eq!(Err(6), x.flatten());
let x: Result<Result<&'static str, u32>, u32> = Err(6);
assert_eq!(Err(6), x.flatten());
Flattening only removes one level of nesting at a time:
let x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok("hello")));
assert_eq!(Ok(Ok("hello")), x.flatten());
assert_eq!(Ok("hello"), x.flatten().flatten());
Trait Implementations§
Source§impl<'de, T, E> Deserialize<'de> for Result<T, E>where
T: Deserialize<'de>,
E: Deserialize<'de>,
impl<'de, T, E> Deserialize<'de> for Result<T, E>where
T: Deserialize<'de>,
E: Deserialize<'de>,
Source§fn deserialize<D>(
deserializer: D,
) -> Result<Result<T, E>, <D as Deserializer<'de>>::Error> ⓘwhere
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D,
) -> Result<Result<T, E>, <D as Deserializer<'de>>::Error> ⓘwhere
D: Deserializer<'de>,
Source§impl<L, R> From<Either<L, R>> for Result<R, L>
Convert from Either
to Result
with Right => Ok
and Left => Err
.
impl<L, R> From<Either<L, R>> for Result<R, L>
Convert from Either
to Result
with Right => Ok
and Left => Err
.
Source§impl<L, R> From<Result<R, L>> for Either<L, R>
Convert from Result
to Either
with Ok => Right
and Err => Left
.
impl<L, R> From<Result<R, L>> for Either<L, R>
Convert from Result
to Either
with Ok => Right
and Err => Left
.
1.0.0 · Source§impl<A, E, V> FromIterator<Result<A, E>> for Result<V, E>where
V: FromIterator<A>,
impl<A, E, V> FromIterator<Result<A, E>> for Result<V, E>where
V: FromIterator<A>,
Source§fn from_iter<I>(iter: I) -> Result<V, E> ⓘwhere
I: IntoIterator<Item = Result<A, E>>,
fn from_iter<I>(iter: I) -> Result<V, E> ⓘwhere
I: IntoIterator<Item = Result<A, E>>,
Takes each element in the Iterator
: if it is an Err
, no further
elements are taken, and the Err
is returned. Should no Err
occur, a
container with the values of each Result
is returned.
Here is an example which increments every integer in a vector, checking for overflow:
let v = vec![1, 2];
let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
x.checked_add(1).ok_or("Overflow!")
).collect();
assert_eq!(res, Ok(vec![2, 3]));
Here is another example that tries to subtract one from another list of integers, this time checking for underflow:
let v = vec![1, 2, 0];
let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
x.checked_sub(1).ok_or("Underflow!")
).collect();
assert_eq!(res, Err("Underflow!"));
Here is a variation on the previous example, showing that no
further elements are taken from iter
after the first Err
.
let v = vec![3, 2, 1, 10];
let mut shared = 0;
let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {
shared += x;
x.checked_sub(2).ok_or("Underflow!")
}).collect();
assert_eq!(res, Err("Underflow!"));
assert_eq!(shared, 6);
Since the third element caused an underflow, no further elements were taken,
so the final value of shared
is 6 (= 3 + 2 + 1
), not 16.
§impl<T, E, V> FromIteratorIn<Result<T, E>> for Result<V, E>where
V: FromIteratorIn<T>,
impl<T, E, V> FromIteratorIn<Result<T, E>> for Result<V, E>where
V: FromIteratorIn<T>,
§fn from_iter_in<I>(
iter: I,
alloc: <Result<V, E> as FromIteratorIn<Result<T, E>>>::Alloc,
) -> Result<V, E> ⓘwhere
I: IntoIterator<Item = Result<T, E>>,
fn from_iter_in<I>(
iter: I,
alloc: <Result<V, E> as FromIteratorIn<Result<T, E>>>::Alloc,
) -> Result<V, E> ⓘwhere
I: IntoIterator<Item = Result<T, E>>,
Takes each element in the Iterator
: if it is an Err
, no further
elements are taken, and the Err
is returned. Should no Err
occur, a
container with the values of each Result
is returned.
Here is an example which increments every integer in a vector, checking for overflow:
let bump = Bump::new();
let v = vec![1, 2, u32::MAX];
let res: Result<Vec<u32>, &'static str> = v.iter().take(2).map(|x: &u32|
x.checked_add(1).ok_or("Overflow!")
).collect_in(&bump);
assert_eq!(res, Ok(bumpalo::vec![in ≎ 2, 3]));
let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
x.checked_add(1).ok_or("Overflow!")
).collect_in(&bump);
assert_eq!(res, Err("Overflow!"));
§type Alloc = <V as FromIteratorIn<T>>::Alloc
type Alloc = <V as FromIteratorIn<T>>::Alloc
§impl<C, T, E> FromParallelIterator<Result<T, E>> for Result<C, E>
Collect an arbitrary Result
-wrapped collection.
impl<C, T, E> FromParallelIterator<Result<T, E>> for Result<C, E>
Collect an arbitrary Result
-wrapped collection.
If any item is Err
, then all previous Ok
items collected are
discarded, and it returns that error. If there are multiple errors, the
one returned is not deterministic.
§fn from_par_iter<I>(par_iter: I) -> Result<C, E> ⓘwhere
I: IntoParallelIterator<Item = Result<T, E>>,
fn from_par_iter<I>(par_iter: I) -> Result<C, E> ⓘwhere
I: IntoParallelIterator<Item = Result<T, E>>,
par_iter
. Read moreSource§impl<T, E, F> FromResidual<Result<Infallible, E>> for Poll<Option<Result<T, F>>>where
F: From<E>,
impl<T, E, F> FromResidual<Result<Infallible, E>> for Poll<Option<Result<T, F>>>where
F: From<E>,
Source§fn from_residual(x: Result<Infallible, E>) -> Poll<Option<Result<T, F>>>
fn from_residual(x: Result<Infallible, E>) -> Poll<Option<Result<T, F>>>
try_trait_v2
)Residual
type. Read moreSource§impl<T, E, F> FromResidual<Result<Infallible, E>> for Poll<Result<T, F>>where
F: From<E>,
impl<T, E, F> FromResidual<Result<Infallible, E>> for Poll<Result<T, F>>where
F: From<E>,
Source§fn from_residual(x: Result<Infallible, E>) -> Poll<Result<T, F>>
fn from_residual(x: Result<Infallible, E>) -> Poll<Result<T, F>>
try_trait_v2
)Residual
type. Read moreSource§impl<T, E, F> FromResidual<Result<Infallible, E>> for Result<T, F>where
F: From<E>,
impl<T, E, F> FromResidual<Result<Infallible, E>> for Result<T, F>where
F: From<E>,
Source§fn from_residual(residual: Result<Infallible, E>) -> Result<T, F> ⓘ
fn from_residual(residual: Result<Infallible, E>) -> Result<T, F> ⓘ
try_trait_v2
)Residual
type. Read more1.4.0 · Source§impl<'a, T, E> IntoIterator for &'a Result<T, E>
impl<'a, T, E> IntoIterator for &'a Result<T, E>
1.4.0 · Source§impl<'a, T, E> IntoIterator for &'a mut Result<T, E>
impl<'a, T, E> IntoIterator for &'a mut Result<T, E>
1.0.0 · Source§impl<T, E> IntoIterator for Result<T, E>
impl<T, E> IntoIterator for Result<T, E>
Source§fn into_iter(self) -> IntoIter<T> ⓘ
fn into_iter(self) -> IntoIter<T> ⓘ
Returns a consuming iterator over the possibly contained value.
The iterator yields one value if the result is Result::Ok
, otherwise none.
§Examples
let x: Result<u32, &str> = Ok(5);
let v: Vec<u32> = x.into_iter().collect();
assert_eq!(v, [5]);
let x: Result<u32, &str> = Err("nothing!");
let v: Vec<u32> = x.into_iter().collect();
assert_eq!(v, []);
§impl<'a, T, E> IntoParallelIterator for &'a Result<T, E>where
T: Sync,
impl<'a, T, E> IntoParallelIterator for &'a Result<T, E>where
T: Sync,
§impl<'a, T, E> IntoParallelIterator for &'a mut Result<T, E>where
T: Send,
impl<'a, T, E> IntoParallelIterator for &'a mut Result<T, E>where
T: Send,
§impl<T, E> IntoParallelIterator for Result<T, E>where
T: Send,
impl<T, E> IntoParallelIterator for Result<T, E>where
T: Send,
§impl<'a, T> MutexExt<'a, T, Result<MutexGuard<'a, T>, PoisonError<MutexGuard<'a, T>>>> for Mutex<T>
impl<'a, T> MutexExt<'a, T, Result<MutexGuard<'a, T>, PoisonError<MutexGuard<'a, T>>>> for Mutex<T>
§fn lock_py_attached(
&'a self,
_py: Python<'_>,
) -> Result<MutexGuard<'a, T>, PoisonError<MutexGuard<'a, T>>> ⓘ
fn lock_py_attached( &'a self, _py: Python<'_>, ) -> Result<MutexGuard<'a, T>, PoisonError<MutexGuard<'a, T>>> ⓘ
Mutex
in a manner that cannot deadlock with the Python interpreter. Read more1.0.0 · Source§impl<T, E> Ord for Result<T, E>
impl<T, E> Ord for Result<T, E>
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
1.0.0 · Source§impl<T, E> PartialOrd for Result<T, E>where
T: PartialOrd,
E: PartialOrd,
impl<T, E> PartialOrd for Result<T, E>where
T: PartialOrd,
E: PartialOrd,
1.16.0 · Source§impl<T, U, E> Product<Result<U, E>> for Result<T, E>where
T: Product<U>,
impl<T, U, E> Product<Result<U, E>> for Result<T, E>where
T: Product<U>,
Source§fn product<I>(iter: I) -> Result<T, E> ⓘ
fn product<I>(iter: I) -> Result<T, E> ⓘ
Takes each element in the Iterator
: if it is an Err
, no further
elements are taken, and the Err
is returned. Should no Err
occur, the product of all elements is returned.
§Examples
This multiplies each number in a vector of strings,
if a string could not be parsed the operation returns Err
:
let nums = vec!["5", "10", "1", "2"];
let total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();
assert_eq!(total, Ok(100));
let nums = vec!["5", "10", "one", "2"];
let total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();
assert!(total.is_err());
Source§impl<T, E> Residual<T> for Result<Infallible, E>
impl<T, E> Residual<T> for Result<Infallible, E>
Source§impl<T, E> Serialize for Result<T, E>
impl<T, E> Serialize for Result<T, E>
Source§fn serialize<S>(
&self,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> ⓘwhere
S: Serializer,
fn serialize<S>(
&self,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> ⓘwhere
S: Serializer,
1.16.0 · Source§impl<T, U, E> Sum<Result<U, E>> for Result<T, E>where
T: Sum<U>,
impl<T, U, E> Sum<Result<U, E>> for Result<T, E>where
T: Sum<U>,
Source§fn sum<I>(iter: I) -> Result<T, E> ⓘ
fn sum<I>(iter: I) -> Result<T, E> ⓘ
Takes each element in the Iterator
: if it is an Err
, no further
elements are taken, and the Err
is returned. Should no Err
occur, the sum of all elements is returned.
§Examples
This sums up every integer in a vector, rejecting the sum if a negative element is encountered:
let f = |&x: &i32| if x < 0 { Err("Negative element found") } else { Ok(x) };
let v = vec![1, 2];
let res: Result<i32, _> = v.iter().map(f).sum();
assert_eq!(res, Ok(3));
let v = vec![1, -2];
let res: Result<i32, _> = v.iter().map(f).sum();
assert_eq!(res, Err("Negative element found"));
1.61.0 · Source§impl<T, E> Termination for Result<T, E>where
T: Termination,
E: Debug,
impl<T, E> Termination for Result<T, E>where
T: Termination,
E: Debug,
Source§impl<T, E> Try for Result<T, E>
impl<T, E> Try for Result<T, E>
Source§type Output = T
type Output = T
try_trait_v2
)?
when not short-circuiting.Source§type Residual = Result<Infallible, E>
type Residual = Result<Infallible, E>
try_trait_v2
)FromResidual::from_residual
as part of ?
when short-circuiting. Read moreSource§fn from_output(output: <Result<T, E> as Try>::Output) -> Result<T, E> ⓘ
fn from_output(output: <Result<T, E> as Try>::Output) -> Result<T, E> ⓘ
try_trait_v2
)Output
type. Read moreSource§fn branch(
self,
) -> ControlFlow<<Result<T, E> as Try>::Residual, <Result<T, E> as Try>::Output>
fn branch( self, ) -> ControlFlow<<Result<T, E> as Try>::Residual, <Result<T, E> as Try>::Output>
try_trait_v2
)?
to decide whether the operator should produce a value
(because this returned ControlFlow::Continue
)
or propagate a value back to the caller
(because this returned ControlFlow::Break
). Read moreimpl<T, E> Copy for Result<T, E>
impl<T, E> Eq for Result<T, E>
impl<T, E> StructuralPartialEq for Result<T, E>
impl<T, E> UseCloned for Result<T, E>
Auto Trait Implementations§
impl<T, E> Freeze for Result<T, E>
impl<T, E> RefUnwindSafe for Result<T, E>where
T: RefUnwindSafe,
E: RefUnwindSafe,
impl<T, E> Send for Result<T, E>
impl<T, E> Sync for Result<T, E>
impl<T, E> Unpin for Result<T, E>
impl<T, E> UnwindSafe for Result<T, E>where
T: UnwindSafe,
E: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> ByteSized for T
impl<T> ByteSized for T
Source§const BYTE_ALIGN: usize = _
const BYTE_ALIGN: usize = _
Source§fn byte_align(&self) -> usize
fn byte_align(&self) -> usize
Source§fn ptr_size_ratio(&self) -> [usize; 2]
fn ptr_size_ratio(&self) -> [usize; 2]
Source§impl<T, R> Chain<R> for Twhere
T: ?Sized,
impl<T, R> Chain<R> for Twhere
T: ?Sized,
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.Source§impl<T> ExtAny for T
impl<T> ExtAny for T
Source§fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64
fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64
TypeId
of Self
using a custom hasher.Source§fn as_any_mut(&mut self) -> &mut dyn Anywhere
Self: Sized,
fn as_any_mut(&mut self) -> &mut dyn Anywhere
Self: Sized,
Source§impl<T> ExtMem for Twhere
T: ?Sized,
impl<T> ExtMem for Twhere
T: ?Sized,
Source§const NEEDS_DROP: bool = _
const NEEDS_DROP: bool = _
Source§fn mem_align_of<T>() -> usize
fn mem_align_of<T>() -> usize
Source§fn mem_align_of_val(&self) -> usize
fn mem_align_of_val(&self) -> usize
Source§fn mem_size_of<T>() -> usize
fn mem_size_of<T>() -> usize
Source§fn mem_size_of_val(&self) -> usize
fn mem_size_of_val(&self) -> usize
Source§fn mem_needs_drop(&self) -> bool
fn mem_needs_drop(&self) -> bool
true
if dropping values of this type matters. Read moreSource§fn mem_forget(self)where
Self: Sized,
fn mem_forget(self)where
Self: Sized,
self
without running its destructor. Read moreSource§fn mem_replace(&mut self, other: Self) -> Selfwhere
Self: Sized,
fn mem_replace(&mut self, other: Self) -> Selfwhere
Self: Sized,
Source§unsafe fn mem_zeroed<T>() -> T
unsafe fn mem_zeroed<T>() -> T
unsafe_layout
only.T
represented by the all-zero byte-pattern. Read moreSource§unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst
unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst
unsafe_layout
only.T
represented by the all-zero byte-pattern. Read moreSource§fn mem_as_bytes(&self) -> &[u8] ⓘ
fn mem_as_bytes(&self) -> &[u8] ⓘ
unsafe_slice
only.§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T> Hook for T
impl<T> Hook for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<'data, I> IntoParallelRefIterator<'data> for I
impl<'data, I> IntoParallelRefIterator<'data> for I
§type Iter = <&'data I as IntoParallelIterator>::Iter
type Iter = <&'data I as IntoParallelIterator>::Iter
§type Item = <&'data I as IntoParallelIterator>::Item
type Item = <&'data I as IntoParallelIterator>::Item
&'data T
reference type.§fn par_iter(&'data self) -> <I as IntoParallelRefIterator<'data>>::Iter
fn par_iter(&'data self) -> <I as IntoParallelRefIterator<'data>>::Iter
self
into a parallel iterator. Read more§impl<'data, I> IntoParallelRefMutIterator<'data> for I
impl<'data, I> IntoParallelRefMutIterator<'data> for I
§type Iter = <&'data mut I as IntoParallelIterator>::Iter
type Iter = <&'data mut I as IntoParallelIterator>::Iter
§type Item = <&'data mut I as IntoParallelIterator>::Item
type Item = <&'data mut I as IntoParallelIterator>::Item
&'data mut T
reference.§fn par_iter_mut(
&'data mut self,
) -> <I as IntoParallelRefMutIterator<'data>>::Iter
fn par_iter_mut( &'data mut self, ) -> <I as IntoParallelRefMutIterator<'data>>::Iter
self
. Read more