pub trait Stream {
    type Item;

    fn poll_next(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>
    ) -> Poll<Option<Self::Item>>; fn size_hint(&self) -> (usize, Option<usize>) { ... } }
Expand description

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.

Required Associated Types§

Values yielded by the stream.

Required Methods§

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 subsequent poll_next calls.

  • Poll::Ready(None) means that the stream has terminated, and poll_next should not be invoked again.

Panics

Once a stream has finished (returned Ready(None) from poll_next), calling its poll_next method again may panic, block forever, or cause other kinds of problems; the Stream trait places no requirements on the effects of such a call. However, as the poll_next method is not marked unsafe, Rust’s usual rules apply: calls must never cause undefined behavior (memory corruption, incorrect use of unsafe functions, or the like), regardless of the stream’s state.

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§

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§

Implementors§

A Stream implementation that can be polled repeatedly until the future is done. The stream will never return Poll::Pending so polling it in a tight loop is worse than using a blocking synchronous function.

use futures::task::Poll;
use futures::{StreamExt, future, pin_mut};
use future::FusedFuture;

let f = async { 1_u32 };
pin_mut!(f);
let mut r = future::poll_immediate(f);
assert_eq!(r.next().await, Some(Poll::Ready(1)));

let f = async {futures::pending!(); 42_u8};
pin_mut!(f);
let mut p = future::poll_immediate(f);
assert_eq!(p.next().await, Some(Poll::Pending));
assert!(!p.is_terminated());
assert_eq!(p.next().await, Some(Poll::Ready(42)));
assert!(p.is_terminated());
assert_eq!(p.next().await, None);

impl<T> Stream for Receiver<T>

impl Stream for Timer

impl<S: Stream, U: Stream<Item = S::Item>> Stream for Chain<S, U>

impl<'a, S, T> Stream for Cloned<S>where
    S: Stream<Item = &'a T>,
    T: Clone + 'a,

impl<'a, S, T> Stream for Copied<S>where
    S: Stream<Item = &'a T>,
    T: Copy + 'a,

impl<S, P> Stream for Filter<S, P>where
    S: Stream,
    P: FnMut(&S::Item) -> bool,

impl<S: Stream> Stream for Fuse<S>

impl<S, F> Stream for Inspect<S, F>where
    S: Stream,
    F: FnMut(&S::Item),

impl<S, F, B> Stream for Map<S, F>where
    S: Stream,
    F: FnMut(S::Item) -> B,

impl<S, St, F, B> Stream for Scan<S, St, F>where
    S: Stream,
    F: FnMut(&mut St, S::Item) -> Option<B>,

impl<S> Stream for Skip<S>where
    S: Stream,

impl<S, P> Stream for SkipWhile<S, P>where
    S: Stream,
    P: FnMut(&S::Item) -> bool,

impl<S> Stream for StepBy<S>where
    S: Stream,

impl<S: Stream> Stream for Take<S>

impl<S, P> Stream for TakeWhile<S, P>where
    S: Stream,
    P: FnMut(&S::Item) -> bool,

impl<A: Stream, B: Stream> Stream for Zip<A, B>

impl<L, R, T> Stream for Merge<L, R>where
    L: Stream<Item = T>,
    R: Stream<Item = T>,

impl<S, U> Stream for Flatten<S>where
    S: Stream,
    S::Item: IntoStream<IntoStream = U, Item = U::Item>,
    U: Stream,

impl<S, U, F> Stream for FlatMap<S, U, F>where
    S: Stream,
    U: Stream,
    F: FnMut(S::Item) -> U,

impl<S: Stream> Stream for Timeout<S>

impl<T> Stream for Empty<T>

impl<T, F> Stream for FromFn<F>where
    F: FnMut() -> Option<T>,

impl<I: Iterator> Stream for FromIter<I>

impl<T> Stream for Once<T>

impl<T: Clone> Stream for Repeat<T>

impl<T, F> Stream for RepeatWith<F>where
    F: FnMut() -> T,

impl Stream for Interval

impl<T> Stream for Pending<T>

impl<F, T> Stream for Successors<F, T>where
    F: FnMut(&T) -> Option<T>,

impl<R: BufRead> Stream for Lines<R>

impl<R: BufRead> Stream for Split<R>

impl<T: Read + Unpin> Stream for Bytes<T>

impl Stream for Incoming<'_>

impl Stream for ReadDir

impl Stream for Incoming<'_>

impl<T, U> Stream for Framed<T, U>where
    T: AsyncRead + Unpin,
    U: Decoder,

impl<T, D> Stream for FramedRead<T, D>where
    T: AsyncRead + Unpin,
    D: Decoder,

impl<T: Iterator + Send + 'static> Stream for Unblock<T>where
    T::Item: Send + 'static,

impl<T> Stream for Empty<T>

impl<I: Iterator> Stream for Iter<I>

impl<T> Stream for Once<T>

impl<T> Stream for Pending<T>

impl<T, F> Stream for PollFn<F>where
    F: FnMut(&mut Context<'_>) -> Poll<Option<T>>,

impl<T: Clone> Stream for Repeat<T>

impl<T, F> Stream for RepeatWith<F>where
    F: FnMut() -> T,

impl<T, F, Fut, Item> Stream for Unfold<T, F, Fut>where
    F: FnMut(T) -> Fut,
    Fut: Future<Output = Option<(Item, T)>>,

impl<T, E, F, Fut, Item> Stream for TryUnfold<T, F, Fut>where
    F: FnMut(T) -> Fut,
    Fut: Future<Output = Result<Option<(Item, T)>, E>>,

impl<S, St, F, B> Stream for Scan<S, St, F>where
    S: Stream,
    F: FnMut(&mut St, S::Item) -> Option<B>,

impl<S: Stream> Stream for Fuse<S>

impl<S, F, T> Stream for Map<S, F>where
    S: Stream,
    F: FnMut(S::Item) -> T,

impl<S, U, F> Stream for FlatMap<S, U, F>where
    S: Stream,
    U: Stream,
    F: FnMut(S::Item) -> U,

impl<S, U> Stream for Flatten<S>where
    S: Stream<Item = U>,
    U: Stream,

impl<S, F, Fut> Stream for Then<S, F, Fut>where
    S: Stream,
    F: FnMut(S::Item) -> Fut,
    Fut: Future,

impl<S, P> Stream for Filter<S, P>where
    S: Stream,
    P: FnMut(&S::Item) -> bool,

impl<T, S1, S2> Stream for Or<S1, S2>where
    S1: Stream<Item = T>,
    S2: Stream<Item = T>,

impl<T, S1, S2> Stream for Race<S1, S2>where
    S1: Stream<Item = T>,
    S2: Stream<Item = T>,

impl<S, F, T> Stream for FilterMap<S, F>where
    S: Stream,
    F: FnMut(S::Item) -> Option<T>,

impl<S: Stream> Stream for Take<S>

impl<S, P> Stream for TakeWhile<S, P>where
    S: Stream,
    P: FnMut(&S::Item) -> bool,

impl<S: Stream> Stream for Skip<S>

impl<S, P> Stream for SkipWhile<S, P>where
    S: Stream,
    P: FnMut(&S::Item) -> bool,

impl<S: Stream> Stream for StepBy<S>

impl<S: Stream, U: Stream<Item = S::Item>> Stream for Chain<S, U>

impl<'a, S, T> Stream for Cloned<S>where
    S: Stream<Item = &'a T>,
    T: Clone + 'a,

impl<'a, S, T> Stream for Copied<S>where
    S: Stream<Item = &'a T>,
    T: Copy + 'a,

impl<S> Stream for Cycle<S>where
    S: Stream + Clone,

impl<S> Stream for Enumerate<S>where
    S: Stream,

impl<S, F> Stream for Inspect<S, F>where
    S: Stream,
    F: FnMut(&S::Item),

impl<A: Stream, B: Stream> Stream for Zip<A, B>

impl<R: AsyncBufRead> Stream for Lines<R>

impl<R: AsyncBufRead> Stream for Split<R>

impl<R: AsyncRead + Unpin> Stream for Bytes<R>

impl Stream for Body

impl<Notif> Stream for Subscription<Notif>where
    Notif: DeserializeOwned,

impl<A, B, I> Stream for EitherOutput<A, B>where
    A: TryStream<Ok = I>,
    B: TryStream<Ok = I>,

impl<T> Stream for Chan<T>

impl<O> Stream for Boxed<O>

impl<TBehaviour> Stream for Swarm<TBehaviour>where
    TBehaviour: NetworkBehaviour,

impl<T> Stream for TcpListenStream<T>where
    T: Provider,
    T::Listener: Unpin,
    T::Stream: Unpin,
    T::IfWatcher: Unpin,

impl Stream for Listen

impl<T> Stream for Connection<T>where
    T: AsyncRead + AsyncWrite + Send + Unpin + 'static,

impl<T> Stream for BytesConnection<T>where
    T: AsyncRead + AsyncWrite + Send + Unpin + 'static,

impl<T> Stream for Incoming<T>

impl<T> Stream for LocalIncoming<T>

impl<T, S, C> Stream for NetlinkFramed<T, S, C>where
    T: NetlinkDeserializable + Debug,
    S: AsyncSocket,
    C: NetlinkMessageCodec,

impl Stream for Metronome

impl<T> Stream for MeteredReceiver<T>

impl<H> Stream for StorageEventStream<H>

impl Stream for Peerset

impl<Payload> Stream for NotificationReceiver<Payload>

impl<M, R> Stream for Receiver<M, R>where
    R: Unsubscribe,

impl<T> Stream for ReceiverStream<T>

impl<S: Stream> Stream for Timeout<S>

impl<T> Stream for Empty<T>

impl<I> Stream for Iter<I>where
    I: Iterator,

impl<T> Stream for Once<T>

impl<T> Stream for Pending<T>

impl<K, V> Stream for StreamMap<K, V>where
    K: Clone + Unpin,
    V: Stream + Unpin,

impl<T, U> Stream for Framed<T, U>where
    T: AsyncRead,
    U: Decoder,

impl<T, D> Stream for FramedRead<T, D>where
    T: AsyncRead,
    D: Decoder,

impl<T, D> Stream for FramedWrite<T, D>where
    T: Stream,

impl<L, R> Stream for Either<L, R>where
    L: Stream,
    R: Stream<Item = L::Item>,

impl<S: DnsTcpStream> Stream for TcpStream<S>

impl<S: Send, MF: MessageFinalizer> Stream for UdpClientStream<S, MF>

impl<S: UdpSocket + Send + 'static> Stream for UdpStream<S>

impl<S, MF> Stream for DnsMultiplexer<S, MF>where
    S: DnsClientStream + Unpin + 'static,
    MF: MessageFinalizer + Send + Sync + 'static,

impl<S> Stream for TimeoutStream<S>where
    S: TryStream,
    S::Error: From<Error>,

impl Stream for Interval

impl Stream for Stream