Trait futures::stream::Stream
[−]
[src]
pub trait Stream { type Item; type Error; fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error>; fn wait(self) -> Wait<Self>
where
Self: Sized, { ... } fn into_future(self) -> StreamFuture<Self>
where
Self: Sized, { ... } fn map<U, F>(self, f: F) -> Map<Self, F>
where
F: FnMut(Self::Item) -> U,
Self: Sized, { ... } fn map_err<U, F>(self, f: F) -> MapErr<Self, F>
where
F: FnMut(Self::Error) -> U,
Self: Sized, { ... } fn filter<F>(self, f: F) -> Filter<Self, F>
where
F: FnMut(&Self::Item) -> bool,
Self: Sized, { ... } fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F>
where
F: FnMut(Self::Item) -> Option<B>,
Self: Sized, { ... } fn then<F, U>(self, f: F) -> Then<Self, F, U>
where
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture,
Self: Sized, { ... } fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U>
where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>,
Self: Sized, { ... } fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U>
where
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>,
Self: Sized, { ... } fn collect(self) -> Collect<Self>
where
Self: Sized, { ... } fn concat2(self) -> Concat2<Self>
where
Self: Sized,
Self::Item: Extend<<Self::Item as IntoIterator>::Item> + IntoIterator + Default, { ... } fn concat(self) -> Concat<Self>
where
Self: Sized,
Self::Item: Extend<<Self::Item as IntoIterator>::Item> + IntoIterator, { ... } 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::Error>,
Self: Sized, { ... } fn flatten(self) -> Flatten<Self>
where
Self::Item: Stream,
<Self::Item as Stream>::Error: From<Self::Error>,
Self: Sized, { ... } 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>,
Self: Sized, { ... } 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>,
Self: Sized, { ... } fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U>
where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>,
Self: Sized, { ... } fn from_err<E: From<Self::Error>>(self) -> FromErr<Self, E>
where
Self: Sized, { ... } fn take(self, amt: u64) -> Take<Self>
where
Self: Sized, { ... } fn skip(self, amt: u64) -> Skip<Self>
where
Self: Sized, { ... } fn fuse(self) -> Fuse<Self>
where
Self: Sized, { ... } fn by_ref(&mut self) -> &mut Self
where
Self: Sized, { ... } fn catch_unwind(self) -> CatchUnwind<Self>
where
Self: Sized + UnwindSafe, { ... } fn buffered(self, amt: usize) -> Buffered<Self>
where
Self::Item: IntoFuture<Error = Self::Error>,
Self: Sized, { ... } fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self>
where
Self::Item: IntoFuture<Error = Self::Error>,
Self: Sized, { ... } fn merge<S>(self, other: S) -> Merge<Self, S>
where
S: Stream<Error = Self::Error>,
Self: Sized, { ... } fn zip<S>(self, other: S) -> Zip<Self, S>
where
S: Stream<Error = Self::Error>,
Self: Sized, { ... } fn chain<S>(self, other: S) -> Chain<Self, S>
where
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized, { ... } fn peekable(self) -> Peekable<Self>
where
Self: Sized, { ... } fn chunks(self, capacity: usize) -> Chunks<Self>
where
Self: Sized, { ... } fn select<S>(self, other: S) -> Select<Self, S>
where
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized, { ... } fn forward<S>(self, sink: S) -> Forward<Self, S>
where
S: Sink<SinkItem = Self::Item>,
Self::Error: From<S::SinkError>,
Self: Sized, { ... } fn split(self) -> (SplitSink<Self>, SplitStream<Self>)
where
Self: Sink + Sized, { ... } fn inspect<F>(self, f: F) -> Inspect<Self, F>
where
F: FnMut(&Self::Item),
Self: Sized, { ... } }
A stream of values, not all of which may have been produced yet.
Stream
is a trait to represent any source of sequential events or items
which acts like an iterator but long periods of time may pass between
items. Like Future
the methods of Stream
never block and it is thus
suitable for programming in an asynchronous fashion. This trait is very
similar to the Iterator
trait in the standard library where Some
is
used to signal elements of the stream and None
is used to indicate that
the stream is finished.
Like futures a stream has basic combinators to transform the stream, perform more work on each item, etc.
You can find more information/tutorials about streams online at https://tokio.rs
Streams as Futures
Any instance of Stream
can also be viewed as a Future
where the resolved
value is the next item in the stream along with the rest of the stream. The
into_future
adaptor can be used here to convert any stream into a future
for use with other future methods like join
and select
.
Errors
Streams, like futures, can also model errors in their computation. All
streams have an associated Error
type like with futures. Currently as of
the 0.1 release of this library an error on a stream does not terminate
the stream. That is, after one error is received, another error may be
received from the same stream (it's valid to keep polling).
This property of streams, however, is being considered for change in 0.2
where an error on a stream is similar to None
, it terminates the stream
entirely. If one of these use cases suits you perfectly and not the other,
please feel welcome to comment on the issue!
Associated Types
type Item
The type of item this stream will yield on success.
type Error
The type of error this stream may generate.
Required Methods
fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error>
Attempt to pull out the next value of this stream, returning None
if
the stream is finished.
This method, like Future::poll
, is the sole method of pulling out a
value from a stream. This method must also be run within the context of
a task typically and implementors of this trait must ensure that
implementations of this method do not block, as it may cause consumers
to behave badly.
Return value
If NotReady
is returned then this stream's next value is not ready
yet and implementations will ensure that the current task will be
notified when the next value may be ready. If Some
is returned then
the returned value represents the next value on the stream. Err
indicates an error happened, while Ok
indicates whether there was a
new item on the stream or whether the stream has terminated.
Panics
Once a stream is finished, that is Ready(None)
has been returned,
further calls to poll
may result in a panic or other "bad behavior".
If this is difficult to guard against then the fuse
adapter can be
used to ensure that poll
always has well-defined semantics.
Provided Methods
fn wait(self) -> Wait<Self> where
Self: Sized,
Self: Sized,
Creates an iterator which blocks the current thread until each item of this stream is resolved.
This method will consume ownership of this stream, returning an
implementation of a standard iterator. This iterator will block the
current thread on each call to next
if the item in the stream isn't
ready yet.
Note: This method is not appropriate to call on event loops or similar I/O situations because it will prevent the event loop from making progress (this blocks the thread). This method should only be called when it's guaranteed that the blocking work associated with this stream will be completed by another thread.
This method is only available when the use_std
feature of this
library is activated, and it is activated by default.
Panics
The returned iterator does not attempt to catch panics. If the poll
function panics, panics will be propagated to the caller of next
.
fn into_future(self) -> StreamFuture<Self> where
Self: Sized,
Self: Sized,
Converts this stream into a Future
.
A stream can be viewed as a future which will resolve to a pair containing
the next element of the stream plus the remaining stream. If the stream
terminates, then the next element is None
and the remaining stream is
still passed back, to allow reclamation of its resources.
The returned future can be used to compose streams and futures together by placing everything into the "world of futures".
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> U,
Self: Sized,
F: FnMut(Self::Item) -> U,
Self: Sized,
Converts a stream of type T
to a stream of type U
.
The provided closure is executed over all elements of this stream as
they are made available, and the callback will be executed inline with
calls to poll
.
Note that this function consumes the receiving stream and returns a
wrapped version of it, similar to the existing map
methods in the
standard library.
Examples
use futures::prelude::*; use futures::sync::mpsc; let (_tx, rx) = mpsc::channel::<i32>(1); let rx = rx.map(|x| x + 3);
fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
F: FnMut(Self::Error) -> U,
Self: Sized,
F: FnMut(Self::Error) -> U,
Self: Sized,
Converts a stream of error type T
to a stream of error type U
.
The provided closure is executed over all errors of this stream as
they are made available, and the callback will be executed inline with
calls to poll
.
Note that this function consumes the receiving stream and returns a
wrapped version of it, similar to the existing map_err
methods in the
standard library.
Examples
use futures::prelude::*; use futures::sync::mpsc; let (_tx, rx) = mpsc::channel::<i32>(1); let rx = rx.map_err(|()| 3);
fn filter<F>(self, f: F) -> Filter<Self, F> where
F: FnMut(&Self::Item) -> bool,
Self: Sized,
F: FnMut(&Self::Item) -> bool,
Self: Sized,
Filters the values produced by this stream according to the provided predicate.
As values of this stream are made available, the provided predicate will
be run against them. If the predicate returns true
then the stream
will yield the value, but if the predicate returns false
then the
value will be discarded and the next value will be produced.
All errors are passed through without filtering in this combinator.
Note that this function consumes the receiving stream and returns a
wrapped version of it, similar to the existing filter
methods in the
standard library.
Examples
use futures::prelude::*; use futures::sync::mpsc; let (_tx, rx) = mpsc::channel::<i32>(1); let evens = rx.filter(|x| x % 2 == 0);
fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<B>,
Self: Sized,
F: FnMut(Self::Item) -> Option<B>,
Self: Sized,
Filters the values produced by this stream while simultaneously mapping them to a different type.
As values of this stream are made available, the provided function will
be run on them. If the predicate returns Some(e)
then the stream will
yield the value e
, but if the predicate returns None
then the next
value will be produced.
All errors are passed through without filtering in this combinator.
Note that this function consumes the receiving stream and returns a
wrapped version of it, similar to the existing filter_map
methods in the
standard library.
Examples
use futures::prelude::*; use futures::sync::mpsc; let (_tx, rx) = mpsc::channel::<i32>(1); let evens_plus_one = rx.filter_map(|x| { if x % 0 == 2 { Some(x + 1) } else { None } });
fn then<F, U>(self, f: F) -> Then<Self, F, U> where
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture,
Self: Sized,
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture,
Self: Sized,
Chain on a computation for when a value is ready, passing the resulting
item to the provided closure f
.
This function can be used to ensure a computation runs regardless of
the next value on the stream. The closure provided will be yielded a
Result
once a value is ready, and the returned future will then be run
to completion to produce the next value on this stream.
The returned value of the closure must implement the IntoFuture
trait
and can represent some more work to be done before the composed stream
is finished. Note that the Result
type implements the IntoFuture
trait so it is possible to simply alter the Result
yielded to the
closure and return it.
Note that this function consumes the receiving stream and returns a wrapped version of it.
Examples
use futures::prelude::*; use futures::sync::mpsc; let (_tx, rx) = mpsc::channel::<i32>(1); let rx = rx.then(|result| { match result { Ok(e) => Ok(e + 3), Err(()) => Err(4), } });
fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>,
Self: Sized,
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>,
Self: Sized,
Chain on a computation for when a value is ready, passing the successful
results to the provided closure f
.
This function can be used to run a unit of work when the next successful value on a stream is ready. The closure provided will be yielded a value when ready, and the returned future will then be run to completion to produce the next value on this stream.
Any errors produced by this stream will not be passed to the closure, and will be passed through.
The returned value of the closure must implement the IntoFuture
trait
and can represent some more work to be done before the composed stream
is finished. Note that the Result
type implements the IntoFuture
trait so it is possible to simply alter the Result
yielded to the
closure and return it.
Note that this function consumes the receiving stream and returns a wrapped version of it.
To process the entire stream and return a single future representing
success or error, use for_each
instead.
Examples
use futures::prelude::*; use futures::sync::mpsc; let (_tx, rx) = mpsc::channel::<i32>(1); let rx = rx.and_then(|result| { if result % 2 == 0 { Ok(result) } else { Err(()) } });
fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U> where
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>,
Self: Sized,
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>,
Self: Sized,
Chain on a computation for when an error happens, passing the
erroneous result to the provided closure f
.
This function can be used to run a unit of work and attempt to recover from an error if one happens. The closure provided will be yielded an error when one appears, and the returned future will then be run to completion to produce the next value on this stream.
Any successful values produced by this stream will not be passed to the closure, and will be passed through.
The returned value of the closure must implement the IntoFuture
trait
and can represent some more work to be done before the composed stream
is finished. Note that the Result
type implements the IntoFuture
trait so it is possible to simply alter the Result
yielded to the
closure and return it.
Note that this function consumes the receiving stream and returns a wrapped version of it.
fn collect(self) -> Collect<Self> where
Self: Sized,
Self: Sized,
Collect all of the values of this stream into a vector, returning a future representing the result of that computation.
This combinator will collect all successful results of this stream and
collect them into a Vec<Self::Item>
. If an error happens then all
collected elements will be dropped and the error will be returned.
The returned future will be resolved whenever an error happens or when
the stream returns Ok(None)
.
This method is only available when the use_std
feature of this
library is activated, and it is activated by default.
Examples
use std::thread; use futures::prelude::*; use futures::sync::mpsc; let (mut tx, rx) = mpsc::channel(1); thread::spawn(|| { for i in (0..5).rev() { tx = tx.send(i + 1).wait().unwrap(); } }); let mut result = rx.collect(); assert_eq!(result.wait(), Ok(vec![5, 4, 3, 2, 1]));
fn concat2(self) -> Concat2<Self> where
Self: Sized,
Self::Item: Extend<<Self::Item as IntoIterator>::Item> + IntoIterator + Default,
Self: Sized,
Self::Item: Extend<<Self::Item as IntoIterator>::Item> + IntoIterator + Default,
Concatenate all results of a stream into a single extendable destination, returning a future representing the end result.
This combinator will extend the first item with the contents of all the successful results of the stream. If the stream is empty, the default value will be returned. If an error occurs, all the results will be dropped and the error will be returned.
The name concat2
is an intermediate measure until the release of
futures 0.2, at which point it will be renamed back to concat
.
Examples
use std::thread; use futures::prelude::*; use futures::sync::mpsc; let (mut tx, rx) = mpsc::channel(1); thread::spawn(move || { for i in (0..3).rev() { let n = i * 3; tx = tx.send(vec![n + 1, n + 2, n + 3]).wait().unwrap(); } }); let result = rx.concat2(); assert_eq!(result.wait(), Ok(vec![7, 8, 9, 4, 5, 6, 1, 2, 3]));
fn concat(self) -> Concat<Self> where
Self: Sized,
Self::Item: Extend<<Self::Item as IntoIterator>::Item> + IntoIterator,
Self: Sized,
Self::Item: Extend<<Self::Item as IntoIterator>::Item> + IntoIterator,
: please use Stream::concat2
instead
Concatenate all results of a stream into a single extendable destination, returning a future representing the end result.
This combinator will extend the first item with the contents of all the successful results of the stream. If an error occurs, all the results will be dropped and the error will be returned.
Examples
use std::thread; use futures::prelude::*; use futures::sync::mpsc; let (mut tx, rx) = mpsc::channel(1); thread::spawn(move || { for i in (0..3).rev() { let n = i * 3; tx = tx.send(vec![n + 1, n + 2, n + 3]).wait().unwrap(); } }); let result = rx.concat(); assert_eq!(result.wait(), Ok(vec![7, 8, 9, 4, 5, 6, 1, 2, 3]));
Panics
It's important to note that this function will panic if the stream is empty, which is the reason for its deprecation.
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::Error>,
Self: Sized,
F: FnMut(T, Self::Item) -> Fut,
Fut: IntoFuture<Item = T>,
Self::Error: From<Fut::Error>,
Self: Sized,
Execute an accumulating computation over a stream, collecting all the values into one final result.
This combinator will collect all successful results of this stream according to the closure provided. The initial state is also provided to this method and then is returned again by each execution of the closure. Once the entire stream has been exhausted the returned future will resolve to this value.
If an error happens then collected state will be dropped and the error will be returned.
Examples
use futures::prelude::*; use futures::stream; use futures::future; let number_stream = stream::iter::<_, _, ()>((0..6).map(Ok)); let sum = number_stream.fold(0, |acc, x| future::ok(acc + x)); assert_eq!(sum.wait(), Ok(15));
fn flatten(self) -> Flatten<Self> where
Self::Item: Stream,
<Self::Item as Stream>::Error: From<Self::Error>,
Self: Sized,
Self::Item: Stream,
<Self::Item as Stream>::Error: From<Self::Error>,
Self: Sized,
Flattens a stream of streams into just one continuous stream.
If this stream's elements are themselves streams then this combinator will flatten out the entire stream to one long chain of elements. Any errors are passed through without looking at them, but otherwise each individual stream will get exhausted before moving on to the next.
use std::thread; use futures::prelude::*; use futures::sync::mpsc; let (tx1, rx1) = mpsc::channel::<i32>(1); let (tx2, rx2) = mpsc::channel::<i32>(1); let (tx3, rx3) = mpsc::channel(1); thread::spawn(|| { tx1.send(1).wait().unwrap() .send(2).wait().unwrap(); }); thread::spawn(|| { tx2.send(3).wait().unwrap() .send(4).wait().unwrap(); }); thread::spawn(|| { tx3.send(rx1).wait().unwrap() .send(rx2).wait().unwrap(); }); let mut result = rx3.flatten().collect(); assert_eq!(result.wait(), Ok(vec![1, 2, 3, 4]));
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>,
Self: Sized,
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Self: Sized,
Skip elements on this stream while the predicate provided resolves to
true
.
This function, like Iterator::skip_while
, will skip elements on the
stream until the predicate
resolves to false
. Once one element
returns false all future elements will be returned from the underlying
stream.
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>,
Self: Sized,
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Self: Sized,
Take elements from this stream while the predicate provided resolves to
true
.
This function, like Iterator::take_while
, will take elements from the
stream until the predicate
resolves to false
. Once one element
returns false it will always return that the stream is done.
fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>,
Self: Sized,
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>,
Self: Sized,
Runs this stream to completion, executing the provided closure for each element on the stream.
The closure provided will be called for each item this stream resolves to successfully, producing a future. That future will then be executed to completion before moving on to the next item.
The returned value is a Future
where the Item
type is ()
and
errors are otherwise threaded through. Any error on the stream or in the
closure will cause iteration to be halted immediately and the future
will resolve to that error.
To process each item in the stream and produce another stream instead
of a single future, use and_then
instead.
fn from_err<E: From<Self::Error>>(self) -> FromErr<Self, E> where
Self: Sized,
Self: Sized,
Map this stream's error to any error implementing From
for
this stream's Error
, returning a new stream.
This function does for streams what try!
does for Result
,
by letting the compiler infer the type of the resulting error.
Just as map_err
above, this is useful for example to ensure
that streams have the same error type when used with
combinators.
Note that this function consumes the receiving stream and returns a wrapped version of it.
fn take(self, amt: u64) -> Take<Self> where
Self: Sized,
Self: Sized,
Creates a new stream of at most amt
items of the underlying stream.
Once amt
items have been yielded from this stream then it will always
return that the stream is done.
Errors
Any errors yielded from underlying stream, before the desired amount of items is reached, are passed through and do not affect the total number of items taken.
fn skip(self, amt: u64) -> Skip<Self> where
Self: Sized,
Self: Sized,
Creates a new stream which skips amt
items of the underlying stream.
Once amt
items have been skipped from this stream then it will always
return the remaining items on this stream.
Errors
All errors yielded from underlying stream are passed through and do not affect the total number of items skipped.
fn fuse(self) -> Fuse<Self> where
Self: Sized,
Self: Sized,
Fuse a stream such that poll
will never again be called once it has
finished.
Currently once a stream has returned None
from poll
any further
calls could exhibit bad behavior such as block forever, panic, never
return, etc. If it is known that poll
may be called after stream has
already finished, then this method can be used to ensure that it has
defined semantics.
Once a stream has been fuse
d and it finishes, then it will forever
return None
from poll
. This, unlike for the traits poll
method,
is guaranteed.
Also note that as soon as this stream returns None
it will be dropped
to reclaim resources associated with it.
fn by_ref(&mut self) -> &mut Self where
Self: Sized,
Self: Sized,
Borrows a stream, rather than consuming it.
This is useful to allow applying stream adaptors while still retaining ownership of the original stream.
use futures::prelude::*; use futures::stream; use futures::future; let mut stream = stream::iter_ok::<_, ()>(1..5); let sum = stream.by_ref().take(2).fold(0, |a, b| future::ok(a + b)).wait(); assert_eq!(sum, Ok(3)); // You can use the stream again let sum = stream.take(2).fold(0, |a, b| future::ok(a + b)).wait(); assert_eq!(sum, Ok(7));
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: Sized + UnwindSafe,
Self: Sized + UnwindSafe,
Catches unwinding panics while polling the stream.
Caught panic (if any) will be the last element of the resulting stream.
In general, panics within a stream can propagate all the way out to the task level. This combinator makes it possible to halt unwinding within the stream itself. It's most commonly used within task executors. This method should not be used for error handling.
Note that this method requires the UnwindSafe
bound from the standard
library. This isn't always applied automatically, and the standard
library provides an AssertUnwindSafe
wrapper type to apply it
after-the fact. To assist using this method, the Stream
trait is also
implemented for AssertUnwindSafe<S>
where S
implements Stream
.
This method is only available when the use_std
feature of this
library is activated, and it is activated by default.
Examples
use futures::prelude::*; use futures::stream; let stream = stream::iter_ok::<_, bool>(vec![Some(10), None, Some(11)]); // panic on second element let stream_panicking = stream.map(|o| o.unwrap()); let mut iter = stream_panicking.catch_unwind().wait(); assert_eq!(Ok(10), iter.next().unwrap().ok().unwrap()); assert!(iter.next().unwrap().is_err()); assert!(iter.next().is_none());
fn buffered(self, amt: usize) -> Buffered<Self> where
Self::Item: IntoFuture<Error = Self::Error>,
Self: Sized,
Self::Item: IntoFuture<Error = Self::Error>,
Self: Sized,
An adaptor for creating a buffered list of pending futures.
If this stream's item can be converted into a future, then this adaptor
will buffer up to at most amt
futures and then return results in the
same order as the underlying stream. No more than amt
futures will be
buffered at any point in time, and less than amt
may also be buffered
depending on the state of each future.
The returned stream will be a stream of each future's result, with errors passed through whenever they occur.
This method is only available when the use_std
feature of this
library is activated, and it is activated by default.
fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
Self::Item: IntoFuture<Error = Self::Error>,
Self: Sized,
Self::Item: IntoFuture<Error = Self::Error>,
Self: Sized,
An adaptor for creating a buffered list of pending futures (unordered).
If this stream's item can be converted into a future, then this adaptor
will buffer up to amt
futures and then return results in the order
in which they complete. No more than amt
futures will be buffered at
any point in time, and less than amt
may also be buffered depending on
the state of each future.
The returned stream will be a stream of each future's result, with errors passed through whenever they occur.
This method is only available when the use_std
feature of this
library is activated, and it is activated by default.
fn merge<S>(self, other: S) -> Merge<Self, S> where
S: Stream<Error = Self::Error>,
Self: Sized,
S: Stream<Error = Self::Error>,
Self: Sized,
: 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.
fn zip<S>(self, other: S) -> Zip<Self, S> where
S: Stream<Error = Self::Error>,
Self: Sized,
S: Stream<Error = Self::Error>,
Self: Sized,
An adapter for zipping two streams together.
The zipped stream waits for both streams to produce an item, and then returns that pair. If an error happens, then that error will be returned immediately. If either stream ends then the zipped stream will also end.
fn chain<S>(self, other: S) -> Chain<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
Adapter for chaining two stream.
The resulting stream emits elements from the first stream, and when first stream reaches the end, emits the elements from the second stream.
use futures::prelude::*; use futures::stream; let stream1 = stream::iter(vec![Ok(10), Err(false)]); let stream2 = stream::iter(vec![Err(true), Ok(20)]); let mut chain = stream1.chain(stream2).wait(); assert_eq!(Some(Ok(10)), chain.next()); assert_eq!(Some(Err(false)), chain.next()); assert_eq!(Some(Err(true)), chain.next()); assert_eq!(Some(Ok(20)), chain.next()); assert_eq!(None, chain.next());
fn peekable(self) -> Peekable<Self> where
Self: Sized,
Self: Sized,
Creates a new stream which exposes a peek
method.
Calling peek
returns a reference to the next item in the stream.
fn chunks(self, capacity: usize) -> Chunks<Self> where
Self: Sized,
Self: Sized,
An adaptor for chunking up items of the stream inside a vector.
This combinator will attempt to pull items from this stream and buffer
them into a local vector. At most capacity
items will get buffered
before they're yielded from the returned stream.
Note that the vectors returned from this iterator may not always have
capacity
elements. If the underlying stream ended and only a partial
vector was created, it'll be returned. Additionally if an error happens
from the underlying stream then the currently buffered items will be
yielded.
Errors are passed through the stream unbuffered.
This method is only available when the use_std
feature of this
library is activated, and it is activated by default.
Panics
This method will panic of capacity
is zero.
fn select<S>(self, other: S) -> Select<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first.
This combinator will attempt to pull items from both streams. Each stream will be polled in a round-robin fashion, and whenever a stream is ready to yield an item that item is yielded.
The select
function is similar to merge
except that it requires both
streams to have the same item and error types.
Error are passed through from either stream.
fn forward<S>(self, sink: S) -> Forward<Self, S> where
S: Sink<SinkItem = Self::Item>,
Self::Error: From<S::SinkError>,
Self: Sized,
S: Sink<SinkItem = Self::Item>,
Self::Error: From<S::SinkError>,
Self: Sized,
A future that completes after the given stream has been fully processed into the sink, including flushing.
This future will drive the stream to keep producing items until it is exhausted, sending each item to the sink. It will complete once both the stream is exhausted, and the sink has fully processed received item, flushed successfully, and closed successfully.
Doing stream.forward(sink)
is roughly equivalent to
sink.send_all(stream)
. The returned future will exhaust all items from
self
, sending them all to sink
. Furthermore the sink
will be
closed and flushed.
On completion, the pair (stream, sink)
is returned.
fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
Self: Sink + Sized,
Self: Sink + Sized,
Splits this Stream + Sink
object into separate Stream
and Sink
objects.
This can be useful when you want to split ownership between tasks, or
allow direct interaction between the two objects (e.g. via
Sink::send_all
).
This method is only available when the use_std
feature of this
library is activated, and it is activated by default.
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item),
Self: Sized,
F: FnMut(&Self::Item),
Self: Sized,
Do something with each item of this stream, afterwards passing it on.
This is similar to the Iterator::inspect
method in the standard
library where it allows easily inspecting each value as it passes
through the stream, for example to debug what's going.
Implementors
impl<F> Stream for FlattenStream<F> where
F: Future,
<F as Future>::Item: Stream<Error = F::Error>, type Item = <F::Item as Stream>::Item; type Error = <F::Item as Stream>::Error;impl<F: Future> Stream for IntoStream<F> type Item = F::Item; type Error = F::Error;
impl<I, T, E> Stream for Iter<I> where
I: Iterator<Item = Result<T, E>>, type Item = T; type Error = E;impl<I, E> Stream for IterOk<I, E> where
I: Iterator, type Item = I::Item; type Error = E;impl<I, T, E> Stream for IterResult<I> where
I: Iterator<Item = Result<T, E>>, type Item = T; type Error = E;impl<T, E> Stream for Repeat<T, E> where
T: Clone, type Item = T; type Error = E;impl<S, F, U> Stream for AndThen<S, F, U> where
S: Stream,
F: FnMut(S::Item) -> U,
U: IntoFuture<Error = S::Error>, type Item = U::Item; type Error = S::Error;impl<S1, S2> Stream for Chain<S1, S2> where
S1: Stream,
S2: Stream<Item = S1::Item, Error = S1::Error>, type Item = S1::Item; type Error = S1::Error;impl<T, E> Stream for Empty<T, E> type Item = T; type Error = E;
impl<S, F> Stream for Filter<S, F> where
S: Stream,
F: FnMut(&S::Item) -> bool, type Item = S::Item; type Error = S::Error;impl<S, F, B> Stream for FilterMap<S, F> where
S: Stream,
F: FnMut(S::Item) -> Option<B>, type Item = B; type Error = S::Error;impl<S> Stream for Flatten<S> where
S: Stream,
S::Item: Stream,
<S::Item as Stream>::Error: From<S::Error>, type Item = <S::Item as Stream>::Item; type Error = <S::Item as Stream>::Error;impl<S: Stream, E: From<S::Error>> Stream for FromErr<S, E> type Item = S::Item; type Error = E;
impl<S: Stream> Stream for Fuse<S> type Item = S::Item; type Error = S::Error;
impl<S, F> Stream for Inspect<S, F> where
S: Stream,
F: FnMut(&S::Item), type Item = S::Item; type Error = S::Error;impl<S, F, U> Stream for Map<S, F> where
S: Stream,
F: FnMut(S::Item) -> U, type Item = U; type Error = S::Error;impl<S, F, U> Stream for MapErr<S, F> where
S: Stream,
F: FnMut(S::Error) -> U, type Item = S::Item; type Error = U;impl<S1, S2> Stream for Merge<S1, S2> where
S1: Stream,
S2: Stream<Error = S1::Error>, type Item = MergedItem<S1::Item, S2::Item>; type Error = S1::Error;impl<T, E> Stream for Once<T, E> type Item = T; type Error = E;
impl<S, F, U> Stream for OrElse<S, F, U> where
S: Stream,
F: FnMut(S::Error) -> U,
U: IntoFuture<Item = S::Item>, type Item = S::Item; type Error = U::Error;impl<S: Stream> Stream for Peekable<S> type Item = S::Item; type Error = S::Error;
impl<T, E, F> Stream for PollFn<F> where
F: FnMut() -> Poll<Option<T>, E>, type Item = T; type Error = E;impl<S1, S2> Stream for Select<S1, S2> where
S1: Stream,
S2: Stream<Item = S1::Item, Error = S1::Error>, type Item = S1::Item; type Error = S1::Error;impl<S> Stream for Skip<S> where
S: Stream, type Item = S::Item; type Error = S::Error;impl<S, P, R> Stream for SkipWhile<S, P, R> where
S: Stream,
P: FnMut(&S::Item) -> R,
R: IntoFuture<Item = bool, Error = S::Error>, type Item = S::Item; type Error = S::Error;impl<S> Stream for Take<S> where
S: Stream, type Item = S::Item; type Error = S::Error;impl<S, P, R> Stream for TakeWhile<S, P, R> where
S: Stream,
P: FnMut(&S::Item) -> R,
R: IntoFuture<Item = bool, Error = S::Error>, type Item = S::Item; type Error = S::Error;impl<S, F, U> Stream for Then<S, F, U> where
S: Stream,
F: FnMut(Result<S::Item, S::Error>) -> U,
U: IntoFuture, type Item = U::Item; type Error = U::Error;impl<T, F, Fut, It> Stream for Unfold<T, F, Fut> where
F: FnMut(T) -> Option<Fut>,
Fut: IntoFuture<Item = (It, T)>, type Item = It; type Error = Fut::Error;impl<S1, S2> Stream for Zip<S1, S2> where
S1: Stream,
S2: Stream<Error = S1::Error>, type Item = (S1::Item, S2::Item); type Error = S1::Error;impl<S> Stream for Buffered<S> where
S: Stream,
S::Item: IntoFuture<Error = <S as Stream>::Error>, type Item = <S::Item as IntoFuture>::Item; type Error = <S as Stream>::Error;impl<S> Stream for BufferUnordered<S> where
S: Stream,
S::Item: IntoFuture<Error = <S as Stream>::Error>, type Item = <S::Item as IntoFuture>::Item; type Error = <S as Stream>::Error;impl<S> Stream for CatchUnwind<S> where
S: Stream + UnwindSafe, type Item = Result<S::Item, S::Error>; type Error = Box<Any + Send>;impl<S: Stream> Stream for AssertUnwindSafe<S> type Item = S::Item; type Error = S::Error;
impl<S> Stream for Chunks<S> where
S: Stream, type Item = Vec<<S as Stream>::Item>; type Error = <S as Stream>::Error;impl<S: Stream> Stream for SplitStream<S> type Item = S::Item; type Error = S::Error;
impl<T> Stream for FuturesUnordered<T> where
T: Future, type Item = T::Item; type Error = T::Error;impl<T> Stream for FuturesOrdered<T> where
T: Future, type Item = T::Item; type Error = T::Error;impl<S: ?Sized + Stream> Stream for Box<S> type Item = S::Item; type Error = S::Error;
impl<'a, S: ?Sized + Stream> Stream for &'a mut S type Item = S::Item; type Error = S::Error;
impl<S, U, F, Fut> Stream for With<S, U, F, Fut> where
S: Stream + Sink,
F: FnMut(U) -> Fut,
Fut: IntoFuture, type Item = S::Item; type Error = S::Error;impl<S, U, F, St> Stream for WithFlatMap<S, U, F, St> where
S: Stream + Sink,
F: FnMut(U) -> St,
St: Stream<Item = S::SinkItem, Error = S::SinkError>, type Item = S::Item; type Error = S::Error;impl<S: Stream, E> Stream for SinkFromErr<S, E> type Item = S::Item; type Error = S::Error;
impl<S: Stream, F> Stream for SinkMapErr<S, F> type Item = S::Item; type Error = S::Error;
impl<S> Stream for Buffer<S> where
S: Sink + Stream, type Item = S::Item; type Error = S::Error;impl<T> Stream for futures::sync::mpsc::Receiver<T> type Item = T; type Error = ();
impl<T> Stream for futures::sync::mpsc::UnboundedReceiver<T> type Item = T; type Error = ();
impl<I, E> Stream for futures::sync::mpsc::SpawnHandle<I, E> type Item = I; type Error = E;
impl<T> Stream for futures::unsync::mpsc::Receiver<T> type Item = T; type Error = ();
impl<T> Stream for futures::unsync::mpsc::UnboundedReceiver<T> type Item = T; type Error = ();
impl<I, E> Stream for futures::unsync::mpsc::SpawnHandle<I, E> type Item = I; type Error = E;