[−][src]Trait futures::prelude::Stream
A stream of values produced asynchronously.
If Future<Output = T>
is an asynchronous version of T
, then Stream<Item = T>
is an asynchronous version of Iterator<Item = T>
. A stream
represents a sequence of value-producing events that occur asynchronously to
the caller.
The trait is modeled after Future
, but allows poll_next
to be called
even after a value has been produced, yielding None
once the stream has
been fully exhausted.
Associated Types
Required methods
fn poll_next(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>
[−]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>
Attempt to pull out the next value of this stream, registering the
current task for wakeup if the value is not yet available, and returning
None
if the stream is exhausted.
Return value
There are several possible return values, each indicating a distinct stream state:
-
Poll::Pending
means that this stream's next value is not ready yet. Implementations will ensure that the current task will be notified when the next value may be ready. -
Poll::Ready(Some(val))
means that the stream has successfully produced a value,val
, and may produce further values on subsequentpoll_next
calls. -
Poll::Ready(None)
means that the stream has terminated, andpoll_next
should not be invoked again.
Panics
Once a stream is finished, i.e. Ready(None)
has been returned, further
calls to poll_next
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_next
always returns Ready(None)
in subsequent
calls.
Provided methods
fn size_hint(&self) -> (usize, Option<usize>)
[−]
Returns the bounds on the remaining length of the stream.
Specifically, size_hint()
returns a tuple where the first element
is the lower bound, and the second element is the upper bound.
The second half of the tuple that is returned is an Option
<
usize
>
.
A None
here means that either there is no known upper bound, or the
upper bound is larger than usize
.
Implementation notes
It is not enforced that a stream implementation yields the declared number of elements. A buggy stream may yield less than the lower bound or more than the upper bound of elements.
size_hint()
is primarily intended to be used for optimizations such as
reserving space for the elements of the stream, but must not be
trusted to e.g., omit bounds checks in unsafe code. An incorrect
implementation of size_hint()
should not lead to memory safety
violations.
That said, the implementation should provide a correct estimation, because otherwise it would be a violation of the trait's protocol.
The default implementation returns (0,
None
)
which is correct for any
stream.
Implementations on Foreign Types
impl<'_, S> Stream for &'_ mut S where
S: Stream + Unpin + ?Sized,
[src][−]
S: Stream + Unpin + ?Sized,
type Item = <S as Stream>::Item
fn poll_next(
self: Pin<&mut &'_ mut S>,
cx: &mut Context<'_>
) -> Poll<Option<<&'_ mut S as Stream>::Item>>
[src]
self: Pin<&mut &'_ mut S>,
cx: &mut Context<'_>
) -> Poll<Option<<&'_ mut S as Stream>::Item>>
fn size_hint(&self) -> (usize, Option<usize>)
[src]
impl<S> Stream for Box<S> where
S: Stream + Unpin + ?Sized,
[src][−]
S: Stream + Unpin + ?Sized,
type Item = <S as Stream>::Item
fn poll_next(
self: Pin<&mut Box<S>>,
cx: &mut Context<'_>
) -> Poll<Option<<Box<S> as Stream>::Item>>
[src]
self: Pin<&mut Box<S>>,
cx: &mut Context<'_>
) -> Poll<Option<<Box<S> as Stream>::Item>>
fn size_hint(&self) -> (usize, Option<usize>)
[src]
impl<S> Stream for AssertUnwindSafe<S> where
S: Stream,
[src][−]
S: Stream,
type Item = <S as Stream>::Item
fn poll_next(
self: Pin<&mut AssertUnwindSafe<S>>,
cx: &mut Context<'_>
) -> Poll<Option<<S as Stream>::Item>>
[src]
self: Pin<&mut AssertUnwindSafe<S>>,
cx: &mut Context<'_>
) -> Poll<Option<<S as Stream>::Item>>
fn size_hint(&self) -> (usize, Option<usize>)
[src]
impl<P> Stream for Pin<P> where
P: DerefMut + Unpin,
<P as Deref>::Target: Stream,
[src][−]
P: DerefMut + Unpin,
<P as Deref>::Target: Stream,
type Item = <<P as Deref>::Target as Stream>::Item
fn poll_next(
self: Pin<&mut Pin<P>>,
cx: &mut Context<'_>
) -> Poll<Option<<Pin<P> as Stream>::Item>>
[src]
self: Pin<&mut Pin<P>>,
cx: &mut Context<'_>
) -> Poll<Option<<Pin<P> as Stream>::Item>>
fn size_hint(&self) -> (usize, Option<usize>)
[src]
Implementors
impl<A, B> Stream for Either<A, B> where
A: Stream,
B: Stream<Item = <A as Stream>::Item>,
[src][+]
A: Stream,
B: Stream<Item = <A as Stream>::Item>,
impl<B, St, S, Fut, F> Stream for Scan<St, S, Fut, F> where
F: FnMut(&mut S, <St as Stream>::Item) -> Fut,
Fut: Future<Output = Option<B>>,
St: Stream,
[src][+]
F: FnMut(&mut S, <St as Stream>::Item) -> Fut,
Fut: Future<Output = Option<B>>,
St: Stream,
impl<F> Stream for FlattenStream<F> where
F: Future,
Flatten<F, <F as Future>::Output>: Stream,
[src][+]
F: Future,
Flatten<F, <F as Future>::Output>: Stream,
impl<F> Stream for futures::future::IntoStream<F> where
Once<F>: Stream,
[src][+]
Once<F>: Stream,
impl<Fut> Stream for TryFlattenStream<Fut> where
Fut: TryFuture,
TryFlatten<Fut, <Fut as TryFuture>::Ok>: Stream,
[src][+]
Fut: TryFuture,
TryFlatten<Fut, <Fut as TryFuture>::Ok>: Stream,
impl<Fut> Stream for FuturesOrdered<Fut> where
Fut: Future,
[src][+]
Fut: Future,
impl<Fut> Stream for FuturesUnordered<Fut> where
Fut: Future,
[src][+]
Fut: Future,
impl<Fut> Stream for Once<Fut> where
Fut: Future,
[src][+]
Fut: Future,
impl<Fut, Si> Stream for FlattenSink<Fut, Si> where
TryFlatten<Fut, Si>: Stream,
[src][+]
TryFlatten<Fut, Si>: Stream,
impl<I> Stream for Iter<I> where
I: Iterator,
[src][+]
I: Iterator,
impl<R> Stream for Lines<R> where
R: AsyncBufRead,
[src][+]
R: AsyncBufRead,
impl<S> Stream for Fuse<S> where
S: Stream,
[src][+]
S: Stream,
impl<S> Stream for Peekable<S> where
S: Stream,
[src][+]
S: Stream,
impl<S> Stream for SplitStream<S> where
S: Stream,
[src][+]
S: Stream,
impl<S, F> Stream for SinkMapErr<S, F> where
S: Stream,
[src][+]
S: Stream,
impl<S, Item> Stream for Buffer<S, Item> where
S: Sink<Item> + Stream,
[src][+]
S: Sink<Item> + Stream,
impl<S, Item, E> Stream for SinkErrInto<S, Item, E> where
S: Sink<Item> + Stream,
<S as Sink<Item>>::Error: Into<E>,
[src][+]
S: Sink<Item> + Stream,
<S as Sink<Item>>::Error: Into<E>,
impl<S, Item, U, Fut, F> Stream for With<S, Item, U, Fut, F> where
F: FnMut(U) -> Fut,
Fut: Future,
S: Stream + Sink<Item>,
[src][+]
F: FnMut(U) -> Fut,
Fut: Future,
S: Stream + Sink<Item>,
impl<S, Item, U, St, F> Stream for WithFlatMap<S, Item, U, St, F> where
F: FnMut(U) -> St,
S: Stream + Sink<Item>,
St: Stream<Item = Result<Item, <S as Sink<Item>>::Error>>,
[src][+]
F: FnMut(U) -> St,
S: Stream + Sink<Item>,
St: Stream<Item = Result<Item, <S as Sink<Item>>::Error>>,
impl<St1, St2> Stream for Chain<St1, St2> where
St1: Stream,
St2: Stream<Item = <St1 as Stream>::Item>,
[src][+]
St1: Stream,
St2: Stream<Item = <St1 as Stream>::Item>,
impl<St1, St2> Stream for Select<St1, St2> where
St1: Stream,
St2: Stream<Item = <St1 as Stream>::Item>,
[src][+]
St1: Stream,
St2: Stream<Item = <St1 as Stream>::Item>,
impl<St1, St2> Stream for Zip<St1, St2> where
St1: Stream,
St2: Stream,
[src][+]
St1: Stream,
St2: Stream,
impl<St> Stream for BufferUnordered<St> where
St: Stream,
<St as Stream>::Item: Future,
[src][+]
St: Stream,
<St as Stream>::Item: Future,
impl<St> Stream for Buffered<St> where
St: Stream,
<St as Stream>::Item: Future,
[src][+]
St: Stream,
<St as Stream>::Item: Future,
impl<St> Stream for CatchUnwind<St> where
St: UnwindSafe + Stream,
[src][+]
St: UnwindSafe + Stream,
impl<St> Stream for Chunks<St> where
St: Stream,
[src][+]
St: Stream,
impl<St> Stream for Enumerate<St> where
St: Stream,
[src][+]
St: Stream,
impl<St> Stream for Flatten<St> where
St: Stream,
Flatten<St, <St as Stream>::Item>: Stream,
[src][+]
St: Stream,
Flatten<St, <St as Stream>::Item>: Stream,
impl<St> Stream for futures::stream::IntoStream<St> where
St: TryStream,
[src][+]
St: TryStream,
impl<St> Stream for ReadyChunks<St> where
St: Stream,
[src][+]
St: Stream,
impl<St> Stream for SelectAll<St> where
St: Unpin + Stream,
[src][+]
St: Unpin + Stream,
impl<St> Stream for Skip<St> where
St: Stream,
[src][+]
St: Stream,
impl<St> Stream for Take<St> where
St: Stream,
[src][+]
St: Stream,
impl<St> Stream for TryBufferUnordered<St> where
St: TryStream,
<St as TryStream>::Ok: TryFuture,
<<St as TryStream>::Ok as TryFuture>::Error == <St as TryStream>::Error,
[src][+]
St: TryStream,
<St as TryStream>::Ok: TryFuture,
<<St as TryStream>::Ok as TryFuture>::Error == <St as TryStream>::Error,
impl<St> Stream for TryFlatten<St> where
St: TryStream,
<St as TryStream>::Ok: TryStream,
<<St as TryStream>::Ok as TryStream>::Error: From<<St as TryStream>::Error>,
[src][+]
St: TryStream,
<St as TryStream>::Ok: TryStream,
<<St as TryStream>::Ok as TryStream>::Error: From<<St as TryStream>::Error>,
impl<St, E> Stream for ErrInto<St, E> where
MapErr<St, IntoFn<E>>: Stream,
[src][+]
MapErr<St, IntoFn<E>>: Stream,
impl<St, F> Stream for Inspect<St, F> where
Map<St, InspectFn<F>>: Stream,
[src][+]
Map<St, InspectFn<F>>: Stream,
impl<St, F> Stream for InspectErr<St, F> where
Inspect<IntoStream<St>, InspectErrFn<F>>: Stream,
[src][+]
Inspect<IntoStream<St>, InspectErrFn<F>>: Stream,
impl<St, F> Stream for InspectOk<St, F> where
Inspect<IntoStream<St>, InspectOkFn<F>>: Stream,
[src][+]
Inspect<IntoStream<St>, InspectOkFn<F>>: Stream,
impl<St, F> Stream for Map<St, F> where
F: FnMut1<<St as Stream>::Item>,
St: Stream,
[src][+]
F: FnMut1<<St as Stream>::Item>,
St: Stream,
impl<St, F> Stream for MapErr<St, F> where
Map<IntoStream<St>, MapErrFn<F>>: Stream,
[src][+]
Map<IntoStream<St>, MapErrFn<F>>: Stream,
impl<St, F> Stream for MapOk<St, F> where
Map<IntoStream<St>, MapOkFn<F>>: Stream,
[src][+]
Map<IntoStream<St>, MapOkFn<F>>: Stream,
impl<St, Fut, F> Stream for AndThen<St, Fut, F> where
F: FnMut(<St as TryStream>::Ok) -> Fut,
Fut: TryFuture<Error = <St as TryStream>::Error>,
St: TryStream,
[src][+]
F: FnMut(<St as TryStream>::Ok) -> Fut,
Fut: TryFuture<Error = <St as TryStream>::Error>,
St: TryStream,
impl<St, Fut, F> Stream for Filter<St, Fut, F> where
F: for<'a> FnMut1<&'a <St as Stream>::Item, Output = Fut>,
Fut: Future<Output = bool>,
St: Stream,
[src][+]
F: for<'a> FnMut1<&'a <St as Stream>::Item, Output = Fut>,
Fut: Future<Output = bool>,
St: Stream,
impl<St, Fut, F> Stream for OrElse<St, Fut, F> where
F: FnMut(<St as TryStream>::Error) -> Fut,
Fut: TryFuture<Ok = <St as TryStream>::Ok>,
St: TryStream,
[src][+]
F: FnMut(<St as TryStream>::Error) -> Fut,
Fut: TryFuture<Ok = <St as TryStream>::Ok>,
St: TryStream,
impl<St, Fut, F> Stream for SkipWhile<St, Fut, F> where
F: FnMut(&<St as Stream>::Item) -> Fut,
Fut: Future<Output = bool>,
St: Stream,
[src][+]
F: FnMut(&<St as Stream>::Item) -> Fut,
Fut: Future<Output = bool>,
St: Stream,
impl<St, Fut, F> Stream for TakeWhile<St, Fut, F> where
F: FnMut(&<St as Stream>::Item) -> Fut,
Fut: Future<Output = bool>,
St: Stream,
[src][+]
F: FnMut(&<St as Stream>::Item) -> Fut,
Fut: Future<Output = bool>,
St: Stream,
impl<St, Fut, F> Stream for Then<St, Fut, F> where
F: FnMut(<St as Stream>::Item) -> Fut,
Fut: Future,
St: Stream,
[src][+]
F: FnMut(<St as Stream>::Item) -> Fut,
Fut: Future,
St: Stream,
impl<St, Fut, F> Stream for TryFilter<St, Fut, F> where
F: FnMut(&<St as TryStream>::Ok) -> Fut,
Fut: Future<Output = bool>,
St: TryStream,
[src][+]
F: FnMut(&<St as TryStream>::Ok) -> Fut,
Fut: Future<Output = bool>,
St: TryStream,
impl<St, Fut, F> Stream for TrySkipWhile<St, Fut, F> where
F: FnMut(&<St as TryStream>::Ok) -> Fut,
Fut: TryFuture<Ok = bool, Error = <St as TryStream>::Error>,
St: TryStream,
[src][+]
F: FnMut(&<St as TryStream>::Ok) -> Fut,
Fut: TryFuture<Ok = bool, Error = <St as TryStream>::Error>,
St: TryStream,
impl<St, Fut, F, T> Stream for FilterMap<St, Fut, F> where
F: FnMut1<<St as Stream>::Item, Output = Fut>,
Fut: Future<Output = Option<T>>,
St: Stream,
[src][+]
F: FnMut1<<St as Stream>::Item, Output = Fut>,
Fut: Future<Output = Option<T>>,
St: Stream,
impl<St, Fut, F, T> Stream for TryFilterMap<St, Fut, F> where
F: FnMut(<St as TryStream>::Ok) -> Fut,
Fut: TryFuture<Ok = Option<T>, Error = <St as TryStream>::Error>,
St: TryStream,
[src][+]
F: FnMut(<St as TryStream>::Ok) -> Fut,
Fut: TryFuture<Ok = Option<T>, Error = <St as TryStream>::Error>,
St: TryStream,
impl<St, U, F> Stream for FlatMap<St, U, F> where
Flatten<Map<St, F>, U>: Stream,
[src][+]
Flatten<Map<St, F>, U>: Stream,
impl<T> Stream for Receiver<T>
[src][+]
impl<T> Stream for UnboundedReceiver<T>
[src][+]
impl<T> Stream for Empty<T>
[src][+]
impl<T> Stream for Pending<T>
[src][+]
impl<T> Stream for Repeat<T> where
T: Clone,
[src][+]
T: Clone,
impl<T, F> Stream for PollFn<F> where
F: FnMut(&mut Context<'_>) -> Poll<Option<T>>,
[src][+]
F: FnMut(&mut Context<'_>) -> Poll<Option<T>>,
impl<T, F, Fut, Item> Stream for TryUnfold<T, F, Fut> where
F: FnMut(T) -> Fut,
Fut: TryFuture<Ok = Option<(Item, T)>>,
[src][+]
F: FnMut(T) -> Fut,
Fut: TryFuture<Ok = Option<(Item, T)>>,
impl<T, F, Fut, Item> Stream for Unfold<T, F, Fut> where
F: FnMut(T) -> Fut,
Fut: Future<Output = Option<(Item, T)>>,
[src][+]
F: FnMut(T) -> Fut,
Fut: Future<Output = Option<(Item, T)>>,
impl<T> Stream for Receiver<T>
impl<T> Stream for Receiver<T>
impl<T> Stream for UnboundedReceiver<T>
impl<T> Stream for UnboundedReceiver<T>