Trait merge_streams::MergeStreams

source · [−]
pub trait MergeStreams {
    type Item;
    type Stream: Stream<Item = Self::Item>;
    fn merge(self) -> Self::Stream;
}
Expand description

Combines multiple streams into a single stream of all their outputs.

Items are yielded as soon as they’re received, and the stream continues yield until both streams have been exhausted. The output ordering between streams is not guaranteed.

Examples

use merge_streams::MergeStreams;
use futures_lite::prelude::*;
use futures_lite::{future::block_on, stream};

fn main() {
    block_on(async {
        let a = stream::once(1);
        let b = stream::once(2);
        let c = stream::once(3);
        let mut s = [a, b, c].merge();

        let mut buf = vec![];
        s.for_each(|n| buf.push(n)).await;
        buf.sort_unstable();
        assert_eq!(&buf, &[1, 2, 3]);
    })
}

Associated Types

The resulting output type.

The stream type.

Required methods

Combine multiple streams into a single stream.

Implementations on Foreign Types

Implementors