tokio-rs/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2026-08-27 00:00:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

stream: update StreamExt::merge doc (#2520)

Browse Source
This commit is contained in:
Alice Ryhl
2020-05-21 11:54:52 +02:00
committed by GitHub
parent 9b81580be6
commit 7cb5e3460c
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio/src/stream/mod.rs
+7 -2
View File
@@ -192,12 +192,17 @@ pub trait StreamExt: Stream {
/// Values are produced from the merged stream in the order they arrive from /// Values are produced from the merged stream in the order they arrive from
/// the two source streams. If both source streams provide values /// the two source streams. If both source streams provide values
/// simultaneously, the merge stream alternates between them. This provides /// simultaneously, the merge stream alternates between them. This provides
/// some level of fairness. /// some level of fairness. You should not chain calls to `merge`, as this
/// will break the fairness of the merging.
/// ///
/// The merged stream completes once **both** source streams complete. When /// The merged stream completes once **both** source streams complete. When
/// one source stream completes before the other, the merge stream /// one source stream completes before the other, the merge stream
/// exclusively polls the remaining stream. /// exclusively polls the remaining stream.
/// ///
/// For merging multiple streams, consider using [`StreamMap`] instead.
///
/// [`StreamMap`]: crate::stream::StreamMap
///
/// # Examples /// # Examples
/// ///
/// ``` /// ```
@@ -303,7 +308,7 @@ pub trait StreamExt: Stream {
/// As values of this stream are made available, the provided function will /// As values of this stream are made available, the provided function will
/// be run on them. If the predicate `f` resolves to /// be run on them. If the predicate `f` resolves to
/// [`Some(item)`](Some) then the stream will yield the value `item`, but if /// [`Some(item)`](Some) then the stream will yield the value `item`, but if
/// it resolves to [`None`], then the value value will be skipped. /// it resolves to [`None`], then the value will be skipped.
/// ///
/// Note that this function consumes the stream passed into it and returns a /// Note that this function consumes the stream passed into it and returns a
/// wrapped version of it, similar to [`Iterator::filter_map`] method in the /// wrapped version of it, similar to [`Iterator::filter_map`] method in the