Improve Option::inspect docs
This commit is contained in:
parent
8fb67fb37f
commit
e9059cb8aa
@ -1073,18 +1073,23 @@ pub fn map<U, F>(self, f: F) -> Option<U>
|
||||
}
|
||||
}
|
||||
|
||||
/// Calls the provided closure with a reference to the contained value (if [`Some`]).
|
||||
/// Calls a function with a reference to the contained value if [`Some`].
|
||||
///
|
||||
/// Returns the original option.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// let v = vec![1, 2, 3, 4, 5];
|
||||
/// let list = vec![1, 2, 3];
|
||||
///
|
||||
/// // prints "got: 4"
|
||||
/// let x: Option<&usize> = v.get(3).inspect(|x| println!("got: {x}"));
|
||||
/// // prints "got: 2"
|
||||
/// let x = list
|
||||
/// .get(1)
|
||||
/// .inspect(|x| println!("got: {x}"))
|
||||
/// .expect("list should be long enough");
|
||||
///
|
||||
/// // prints nothing
|
||||
/// let x: Option<&usize> = v.get(5).inspect(|x| println!("got: {x}"));
|
||||
/// list.get(5).inspect(|x| println!("got: {x}"));
|
||||
/// ```
|
||||
#[inline]
|
||||
#[stable(feature = "result_option_inspect", since = "1.76.0")]
|
||||
|
@ -830,7 +830,9 @@ pub fn map_err<F, O: FnOnce(E) -> F>(self, op: O) -> Result<T, F> {
|
||||
}
|
||||
}
|
||||
|
||||
/// Calls the provided closure with a reference to the contained value (if [`Ok`]).
|
||||
/// Calls a function with a reference to the contained value if [`Ok`].
|
||||
///
|
||||
/// Returns the original result.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -851,7 +853,9 @@ pub fn inspect<F: FnOnce(&T)>(self, f: F) -> Self {
|
||||
self
|
||||
}
|
||||
|
||||
/// Calls the provided closure with a reference to the contained error (if [`Err`]).
|
||||
/// Calls a function with a reference to the contained value if [`Err`].
|
||||
///
|
||||
/// Returns the original result.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
|
Loading…
Reference in New Issue
Block a user