about summary refs log tree commit diff
diff options
context:
space:
mode:
authorClément Renault <clement@meilisearch.com>2020-12-31 11:57:40 +0100
committerClément Renault <clement@meilisearch.com>2020-12-31 11:57:40 +0100
commita2d55d70c4c6ef24e114a48864c9483ed92687f7 (patch)
tree65f67e0c3e75e725dcceb3f270bc82ca8c4c89eb
parentb2a7076b10d69ede61092a62a9d5245f5077d184 (diff)
downloadrust-a2d55d70c4c6ef24e114a48864c9483ed92687f7.tar.gz
rust-a2d55d70c4c6ef24e114a48864c9483ed92687f7.zip
Add an extra example to the two methods
-rw-r--r--library/core/src/slice/mod.rs30
1 files changed, 30 insertions, 0 deletions
diff --git a/library/core/src/slice/mod.rs b/library/core/src/slice/mod.rs
index 648cf88b7ef..b4dd057eef0 100644
--- a/library/core/src/slice/mod.rs
+++ b/library/core/src/slice/mod.rs
@@ -1231,6 +1231,21 @@ impl<T> [T] {
     /// assert_eq!(iter.next(), Some(&[2, 2, 2][..]));
     /// assert_eq!(iter.next(), None);
     /// ```
+    ///
+    /// This method can be used to extract the sorted subslices:
+    ///
+    /// ```
+    /// #![feature(slice_group_by)]
+    ///
+    /// let slice = &[1, 1, 2, 3, 2, 3, 2, 3, 4];
+    ///
+    /// let mut iter = slice.group_by(|a, b| a <= b);
+    ///
+    /// assert_eq!(iter.next(), Some(&[1, 1, 2, 3][..]));
+    /// assert_eq!(iter.next(), Some(&[2, 3][..]));
+    /// assert_eq!(iter.next(), Some(&[2, 3, 4][..]));
+    /// assert_eq!(iter.next(), None);
+    /// ```
     #[unstable(feature = "slice_group_by", issue = "none")]
     #[inline]
     pub fn group_by<F>(&self, pred: F) -> GroupBy<'_, T, F>
@@ -1261,6 +1276,21 @@ impl<T> [T] {
     /// assert_eq!(iter.next(), Some(&mut [2, 2, 2][..]));
     /// assert_eq!(iter.next(), None);
     /// ```
+    ///
+    /// This method can be used to extract the sorted subslices:
+    ///
+    /// ```
+    /// #![feature(slice_group_by)]
+    ///
+    /// let slice = &mut [1, 1, 2, 3, 2, 3, 2, 3, 4];
+    ///
+    /// let mut iter = slice.group_by_mut(|a, b| a <= b);
+    ///
+    /// assert_eq!(iter.next(), Some(&mut [1, 1, 2, 3][..]));
+    /// assert_eq!(iter.next(), Some(&mut [2, 3][..]));
+    /// assert_eq!(iter.next(), Some(&mut [2, 3, 4][..]));
+    /// assert_eq!(iter.next(), None);
+    /// ```
     #[unstable(feature = "slice_group_by", issue = "none")]
     #[inline]
     pub fn group_by_mut<F>(&mut self, pred: F) -> GroupByMut<'_, T, F>