Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document From trait for Option implementations #71909

Merged
merged 12 commits into from
May 14, 2020
39 changes: 39 additions & 0 deletions src/libcore/option.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1357,20 +1357,59 @@ impl<'a, T> IntoIterator for &'a mut Option<T> {

#[stable(since = "1.12.0", feature = "option_from")]
impl<T> From<T> for Option<T> {
/// Copies val to a new Option::Some
Dolpheyn marked this conversation as resolved.
Show resolved Hide resolved
///
/// # Examples
///
/// ```
/// let o: Option<u8> = Option::from(67);
/// assert_eq!(Some(67), o);
Dolpheyn marked this conversation as resolved.
Show resolved Hide resolved
/// ```
fn from(val: T) -> Option<T> {
Some(val)
}
}

#[stable(feature = "option_ref_from_ref_option", since = "1.30.0")]
impl<'a, T> From<&'a Option<T>> for Option<&'a T> {
/// Converts from &Option<T> to Option<&T>
Dolpheyn marked this conversation as resolved.
Show resolved Hide resolved
///
/// # Examples
Dolpheyn marked this conversation as resolved.
Show resolved Hide resolved
/// Converts an `Option<`[`String`]`>` into an `Option<`[`usize`]`>`, preserving the original.
/// The [`map`] method takes the `self` argument by value, consuming the original,
/// so this technique uses `as_ref` to first take an `Option` to a reference
/// to the value inside the original.
///
/// [`map`]: enum.Option.html#method.map
Dolpheyn marked this conversation as resolved.
Show resolved Hide resolved
/// [`String`]: ../../std/string/struct.String.html
/// [`usize`]: ../../std/primitive.usize.html
///
/// ```
/// let s: Option<String> = Some(String::from("Hello, Rustaceans!"));
/// let o: Option<usize> = Option::from(&s).map(|ss: &String| ss.len());
/// println!("Can still print s: {:?}", s);
Dolpheyn marked this conversation as resolved.
Show resolved Hide resolved
/// assert_eq!(o, Some(18));
/// ```
fn from(o: &'a Option<T>) -> Option<&'a T> {
o.as_ref()
}
}

#[stable(feature = "option_ref_from_ref_option", since = "1.30.0")]
impl<'a, T> From<&'a mut Option<T>> for Option<&'a mut T> {
/// Converts from &mut Option<T> to Option<&mut T>
Dolpheyn marked this conversation as resolved.
Show resolved Hide resolved
///
/// # Examples
///
/// ```
/// let mut s = Some(String::from("Hello"));
/// let o: Option<&mut String> = Option::from(&mut s);
Dolpheyn marked this conversation as resolved.
Show resolved Hide resolved
/// match o {
/// Some(t) => *t = String::from("Hello, Rustaceans!"),
/// None => (),
/// }
/// assert_eq!(s, Some(String::from("Hello, Rustaceans!")));
Dolpheyn marked this conversation as resolved.
Show resolved Hide resolved
/// ```
fn from(o: &'a mut Option<T>) -> Option<&'a mut T> {
o.as_mut()
}
Expand Down