Rollup merge of #64296 - KodrAus:chore/iter_order_by, r=Centril

Document the unstable iter_order_by library feature

Tracking issue: #64295

Follow-up for: #62205

References the tracking issue and adds a page to the unstable book for the new unstable `iter_order_by` feature.
This commit is contained in:
Mazdak Farrokhzad 2019-09-24 23:45:19 +02:00 committed by GitHub
commit e74d953bdc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -2581,7 +2581,7 @@ fn cmp<I>(self, other: I) -> Ordering
/// assert_eq!(xs.iter().cmp_by(&ys, |&x, &y| (x * x).cmp(&y)), Ordering::Equal); /// assert_eq!(xs.iter().cmp_by(&ys, |&x, &y| (x * x).cmp(&y)), Ordering::Equal);
/// assert_eq!(xs.iter().cmp_by(&ys, |&x, &y| (2 * x).cmp(&y)), Ordering::Greater); /// assert_eq!(xs.iter().cmp_by(&ys, |&x, &y| (2 * x).cmp(&y)), Ordering::Greater);
/// ``` /// ```
#[unstable(feature = "iter_order_by", issue = "0")] #[unstable(feature = "iter_order_by", issue = "64295")]
fn cmp_by<I, F>(mut self, other: I, mut cmp: F) -> Ordering fn cmp_by<I, F>(mut self, other: I, mut cmp: F) -> Ordering
where where
Self: Sized, Self: Sized,
@ -2664,7 +2664,7 @@ fn partial_cmp<I>(self, other: I) -> Option<Ordering>
/// Some(Ordering::Greater) /// Some(Ordering::Greater)
/// ); /// );
/// ``` /// ```
#[unstable(feature = "iter_order_by", issue = "0")] #[unstable(feature = "iter_order_by", issue = "64295")]
fn partial_cmp_by<I, F>(mut self, other: I, mut partial_cmp: F) -> Option<Ordering> fn partial_cmp_by<I, F>(mut self, other: I, mut partial_cmp: F) -> Option<Ordering>
where where
Self: Sized, Self: Sized,
@ -2729,7 +2729,7 @@ fn eq<I>(self, other: I) -> bool
/// ///
/// assert!(xs.iter().eq_by(&ys, |&x, &y| x * x == y)); /// assert!(xs.iter().eq_by(&ys, |&x, &y| x * x == y));
/// ``` /// ```
#[unstable(feature = "iter_order_by", issue = "0")] #[unstable(feature = "iter_order_by", issue = "64295")]
fn eq_by<I, F>(mut self, other: I, mut eq: F) -> bool fn eq_by<I, F>(mut self, other: I, mut eq: F) -> bool
where where
Self: Sized, Self: Sized,