Add examples to bool::then
and bool::then_some
Added examples to `bool::then` and `bool::then_some` to show the distinction between the eager evaluation of `bool::then_some` and the lazy evaluation of `bool::then`.
This commit is contained in:
parent
db4b4d3bec
commit
758ca9dc3a
@ -18,6 +18,18 @@ impl bool {
|
|||||||
/// assert_eq!(false.then_some(0), None);
|
/// assert_eq!(false.then_some(0), None);
|
||||||
/// assert_eq!(true.then_some(0), Some(0));
|
/// assert_eq!(true.then_some(0), Some(0));
|
||||||
/// ```
|
/// ```
|
||||||
|
///
|
||||||
|
/// ```
|
||||||
|
/// let mut a = 0;
|
||||||
|
/// let mut function_with_side_effects = || { a += 1; };
|
||||||
|
///
|
||||||
|
/// true.then_some(function_with_side_effects());
|
||||||
|
/// false.then_some(function_with_side_effects());
|
||||||
|
///
|
||||||
|
/// // `a` is incremented twice because the value passed to `then_some` is
|
||||||
|
/// // evaluated eagerly.
|
||||||
|
/// assert_eq!(a, 2);
|
||||||
|
/// ```
|
||||||
#[stable(feature = "bool_to_option", since = "1.62.0")]
|
#[stable(feature = "bool_to_option", since = "1.62.0")]
|
||||||
#[rustc_const_unstable(feature = "const_bool_to_option", issue = "91917")]
|
#[rustc_const_unstable(feature = "const_bool_to_option", issue = "91917")]
|
||||||
#[inline]
|
#[inline]
|
||||||
@ -37,6 +49,16 @@ pub const fn then_some<T>(self, t: T) -> Option<T>
|
|||||||
/// assert_eq!(false.then(|| 0), None);
|
/// assert_eq!(false.then(|| 0), None);
|
||||||
/// assert_eq!(true.then(|| 0), Some(0));
|
/// assert_eq!(true.then(|| 0), Some(0));
|
||||||
/// ```
|
/// ```
|
||||||
|
///
|
||||||
|
/// ```
|
||||||
|
/// let mut a = 0;
|
||||||
|
///
|
||||||
|
/// true.then(|| { a += 1; });
|
||||||
|
/// false.then(|| { a += 1; });
|
||||||
|
///
|
||||||
|
/// // `a` is incremented once because the closure is evaluated lazily by
|
||||||
|
/// // `then`.
|
||||||
|
/// ```
|
||||||
#[stable(feature = "lazy_bool_to_option", since = "1.50.0")]
|
#[stable(feature = "lazy_bool_to_option", since = "1.50.0")]
|
||||||
#[rustc_const_unstable(feature = "const_bool_to_option", issue = "91917")]
|
#[rustc_const_unstable(feature = "const_bool_to_option", issue = "91917")]
|
||||||
#[inline]
|
#[inline]
|
||||||
|
Loading…
Reference in New Issue
Block a user