Rollup merge of #105034 - HintringerFabian:improve_iterator_flatten_doc, r=cuviper

Add example for iterator_flatten

Adds an Example to iterator_flatten
Fixes #82687
This commit is contained in:
Yuki Okushi 2023-01-10 08:05:32 +09:00 committed by GitHub
commit 002eccc752
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1514,6 +1514,18 @@ pub trait Iterator {
/// assert_eq!(merged, "alphabetagamma");
/// ```
///
/// Flattening works on any `IntoIterator` type, including `Option` and `Result`:
///
/// ```
/// let options = vec![Some(123), Some(321), None, Some(231)];
/// let flattened_options: Vec<_> = options.into_iter().flatten().collect();
/// assert_eq!(flattened_options, vec![123, 321, 231]);
///
/// let results = vec![Ok(123), Ok(321), Err(456), Ok(231)];
/// let flattened_results: Vec<_> = results.into_iter().flatten().collect();
/// assert_eq!(flattened_results, vec![123, 321, 231]);
/// ```
///
/// Flattening only removes one level of nesting at a time:
///
/// ```