Struct heim_common::prelude::stream::Merge

#[must_use = "streams do nothing unless polled"]
pub struct Merge<S1, S2> where
    S2: Stream,  { /* fields omitted */ }

Deprecated:

functionality provided by select now

An adapter for merging the output of two streams.

The merged stream produces items from one or both of the underlying streams as they become available. Errors, however, are not merged: you get at most one error at a time.

Trait Implementations

impl<S1, S2> Debug for Merge<S1, S2> where
    S1: Debug,
    S2: Stream + Debug,
    <S2 as Stream>::Error: Debug, 

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<S1, S2> Stream for Merge<S1, S2> where
    S1: Stream,
    S2: Stream<Error = <S1 as Stream>::Error>, 

type Item = MergedItem<<S1 as Stream>::Item, <S2 as Stream>::Item>

The type of item this stream will yield on success.

type Error = <S1 as Stream>::Error

The type of error this stream may generate.

fn poll(
    &mut self
) -> Result<Async<Option<<Merge<S1, S2> as Stream>::Item>>, <Merge<S1, S2> as Stream>::Error>

Attempt to pull out the next value of this stream, returning None if the stream is finished.

Important traits for Wait<S>

impl<S> Iterator for Wait<S> where
    S: Stream,  type Item = Result<<S as Stream>::Item, <S as Stream>::Error>;

default fn wait(self) -> Wait<Self>

Creates an iterator which blocks the current thread until each item of this stream is resolved.

default fn into_future(self) -> StreamFuture<Self>

Converts this stream into a Future.

default fn map<U, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> U, 

Converts a stream of type T to a stream of type U.

default fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
    F: FnMut(Self::Error) -> U, 

Converts a stream of error type T to a stream of error type U.

default fn filter<F>(self, f: F) -> Filter<Self, F> where
    F: FnMut(&Self::Item) -> bool, 

Filters the values produced by this stream according to the provided predicate.

default fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 

Filters the values produced by this stream while simultaneously mapping them to a different type.

default fn then<F, U>(self, f: F) -> Then<Self, F, U> where
    F: FnMut(Result<Self::Item, Self::Error>) -> U,
    U: IntoFuture, 

Chain on a computation for when a value is ready, passing the resulting item to the provided closure f.

default fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Error = Self::Error>, 

Chain on a computation for when a value is ready, passing the successful results to the provided closure f.

default fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U> where
    F: FnMut(Self::Error) -> U,
    U: IntoFuture<Item = Self::Item>, 

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f.

default fn collect(self) -> Collect<Self>

Collect all of the values of this stream into a vector, returning a future representing the result of that computation.

default fn concat2(self) -> Concat2<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator,
    Self::Item: Default, 

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result.

default fn concat(self) -> Concat<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator, 

Deprecated since 0.1.14:

please use Stream::concat2 instead

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result.

default fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T> where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: IntoFuture<Item = T>,
    Self::Error: From<<Fut as IntoFuture>::Error>, 

Execute an accumulating computation over a stream, collecting all the values into one final result.

default fn flatten(self) -> Flatten<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error: From<Self::Error>, 

Flattens a stream of streams into just one continuous stream.

default fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R> where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>, 

Skip elements on this stream while the predicate provided resolves to true.

default fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R> where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>, 

Take elements from this stream while the predicate provided resolves to true.

default fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Item = (), Error = Self::Error>, 

Runs this stream to completion, executing the provided closure for each element on the stream.

default fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 

Map this stream's error to any error implementing From for this stream's Error, returning a new stream.

default fn take(self, amt: u64) -> Take<Self>

Creates a new stream of at most amt items of the underlying stream.

default fn skip(self, amt: u64) -> Skip<Self>

Creates a new stream which skips amt items of the underlying stream.

default fn fuse(self) -> Fuse<Self>

Fuse a stream such that poll will never again be called once it has finished.

Important traits for &'_ mut R

impl<'_, R> Read for &'_ mut R where
    R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
    W: Write + ?Sized, 

default fn by_ref(&mut self) -> &mut Self

Borrows a stream, rather than consuming it.

default fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, 

Catches unwinding panics while polling the stream.

default fn buffered(self, amt: usize) -> Buffered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error, 

An adaptor for creating a buffered list of pending futures.

default fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error, 

An adaptor for creating a buffered list of pending futures (unordered).

default fn merge<S>(self, other: S) -> Merge<Self, S> where
    S: Stream<Error = Self::Error>, 

Deprecated:

functionality provided by select now

An adapter for merging the output of two streams.

default fn zip<S>(self, other: S) -> Zip<Self, S> where
    S: Stream<Error = Self::Error>, 

An adapter for zipping two streams together.

default fn chain<S>(self, other: S) -> Chain<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, 

Adapter for chaining two stream.

default fn peekable(self) -> Peekable<Self>

Creates a new stream which exposes a peek method.

default fn chunks(self, capacity: usize) -> Chunks<Self>

An adaptor for chunking up items of the stream inside a vector.

default fn select<S>(self, other: S) -> Select<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, 

Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first.

default fn forward<S>(self, sink: S) -> Forward<Self, S> where
    S: Sink<SinkItem = Self::Item>,
    Self::Error: From<<S as Sink>::SinkError>, 

A future that completes after the given stream has been fully processed into the sink, including flushing.

default fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
    Self: Sink, 

Splits this Stream + Sink object into separate Stream and Sink objects.

default fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), 

Do something with each item of this stream, afterwards passing it on.

default fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
    F: FnMut(&Self::Error), 

Do something with the error of this stream, afterwards passing it on.