Trait futures_util::stream::Stream

#[must_use = "streams do nothing unless polled"]
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>) { ... }
}

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

type Item

Values yielded by the stream.

Loading content...

Required methods

fn poll_next(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 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 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.

Loading content...

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.

Loading content...

Implementations on Foreign Types

impl<P> Stream for Pin<P> where
    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>>

fn size_hint(&self) -> (usize, Option<usize>)

Loading content...

Implementors

impl<'_, S> Stream for &'_ mut S where
    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>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<A, B> Stream for Either<A, B> where
    A: Stream,
    B: Stream<Item = A::Item>, 

type Item = A::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<A::Item>>

impl<Fut> Stream for FlattenStream<Fut> where
    Fut: Future,
    Fut::Output: Stream, 

type Item = <Fut::Output as Stream>::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

impl<Fut> Stream for TryFlattenStream<Fut> where
    Fut: TryFuture,
    Fut::Ok: TryStream<Error = Fut::Error>, 

type Item = Result<<Fut::Ok as TryStream>::Ok, Fut::Error>

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

impl<Fut, S> Stream for FlattenSink<Fut, S> where
    Fut: TryFuture<Ok = S>,
    S: TryStream<Error = Fut::Error>, 

type Item = Result<S::Ok, Fut::Error>

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

impl<Fut: Future> Stream for futures_util::future::IntoStream<Fut>

type Item = Fut::Output

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<Fut: Future> Stream for Once<Fut>

type Item = Fut::Output

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

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

type Item = I::Item

fn poll_next(self: Pin<&mut Self>, _: &mut Context) -> Poll<Option<I::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<S, Item, E> Stream for SinkErrInto<S, Item, E> where
    S: Sink<Item> + Stream,
    S::Error: Into<E>, 

type Item = S::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<S::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<S, Item, U, Fut, F> Stream for With<S, Item, U, Fut, F> where
    S: Stream + Sink<Item>,
    F: FnMut(U) -> Fut,
    Fut: Future, 

type Item = S::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<S::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<S, Item, U, St, F> Stream for WithFlatMap<S, Item, U, St, F> where
    S: Stream + Sink<Item>,
    F: FnMut(U) -> St,
    St: Stream<Item = Result<Item, S::Error>>, 

type Item = S::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<S::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

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

type Item = S::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<S::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<S: Stream> Stream for Peekable<S>

type Item = S::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<S: Stream, F> Stream for SinkMapErr<S, F>

type Item = S::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<S::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St> Stream for Flatten<St> where
    St: Stream,
    St::Item: Stream, 

type Item = <St::Item as Stream>::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

impl<St> Stream for Take<St> where
    St: Stream, 

type Item = St::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<St::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St> Stream for TryFlatten<St> where
    St: TryStream,
    St::Ok: TryStream,
    <St::Ok as TryStream>::Error: From<St::Error>, 

type Item = Result<<St::Ok as TryStream>::Ok, <St::Ok as TryStream>::Error>

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

impl<St, E> Stream for ErrInto<St, E> where
    St: TryStream,
    St::Error: Into<E>, 

type Item = Result<St::Ok, E>

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

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

type Item = St::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<St::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St, F> Stream for InspectErr<St, F> where
    St: TryStream,
    F: FnMut(&St::Error), 

type Item = Result<St::Ok, St::Error>

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St, F> Stream for InspectOk<St, F> where
    St: TryStream,
    F: FnMut(&St::Ok), 

type Item = Result<St::Ok, St::Error>

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St, F, E> Stream for MapErr<St, F> where
    St: TryStream,
    F: FnMut(St::Error) -> E, 

type Item = Result<St::Ok, E>

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

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

type Item = T

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<T>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St, F, T> Stream for MapOk<St, F> where
    St: TryStream,
    F: FnMut(St::Ok) -> T, 

type Item = Result<T, St::Error>

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St, Fut, F> Stream for AndThen<St, Fut, F> where
    St: TryStream,
    F: FnMut(St::Ok) -> Fut,
    Fut: TryFuture<Error = St::Error>, 

type Item = Result<Fut::Ok, St::Error>

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St, Fut, F> Stream for Filter<St, Fut, F> where
    St: Stream,
    F: FnMut(&St::Item) -> Fut,
    Fut: Future<Output = bool>, 

type Item = St::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<St::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St, Fut, F> Stream for OrElse<St, Fut, F> where
    St: TryStream,
    F: FnMut(St::Error) -> Fut,
    Fut: TryFuture<Ok = St::Ok>, 

type Item = Result<St::Ok, Fut::Error>

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St, Fut, F> Stream for SkipWhile<St, Fut, F> where
    St: Stream,
    F: FnMut(&St::Item) -> Fut,
    Fut: Future<Output = bool>, 

type Item = St::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<St::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St, Fut, F> Stream for TakeWhile<St, Fut, F> where
    St: Stream,
    F: FnMut(&St::Item) -> Fut,
    Fut: Future<Output = bool>, 

type Item = St::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<St::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

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

type Item = Fut::Output

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Option<Fut::Output>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St, Fut, F> Stream for TryFilter<St, Fut, F> where
    St: TryStream,
    Fut: Future<Output = bool>,
    F: FnMut(&St::Ok) -> Fut, 

type Item = Result<St::Ok, St::Error>

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Option<Result<St::Ok, St::Error>>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St, Fut, F> Stream for TrySkipWhile<St, Fut, F> where
    St: TryStream,
    F: FnMut(&St::Ok) -> Fut,
    Fut: TryFuture<Ok = bool, Error = St::Error>, 

type Item = Result<St::Ok, St::Error>

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

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

type Item = T

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<T>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St, Fut, F, T> Stream for TryFilterMap<St, Fut, F> where
    St: TryStream,
    Fut: TryFuture<Ok = Option<T>, Error = St::Error>,
    F: FnMut(St::Ok) -> Fut, 

type Item = Result<T, St::Error>

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Option<Result<T, St::Error>>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St1, St2> Stream for Chain<St1, St2> where
    St1: Stream,
    St2: Stream<Item = St1::Item>, 

type Item = St1::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St1, St2> Stream for Select<St1, St2> where
    St1: Stream,
    St2: Stream<Item = St1::Item>, 

type Item = St1::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<St1::Item>>

impl<St1, St2> Stream for Zip<St1, St2> where
    St1: Stream,
    St2: Stream, 

type Item = (St1::Item, St2::Item)

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St: Stream> Stream for Enumerate<St>

type Item = (usize, St::Item)

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St: Stream> Stream for Skip<St>

type Item = St::Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<St::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<St: TryStream> Stream for futures_util::stream::IntoStream<St>

type Item = Result<St::Ok, St::Error>

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<T> Stream for Empty<T>

type Item = T

fn poll_next(self: Pin<&mut Self>, _: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<T> Stream for Pending<T>

type Item = T

fn poll_next(self: Pin<&mut Self>, _: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

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

type Item = T

fn poll_next(self: Pin<&mut Self>, _: &mut Context) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

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

type Item = T

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<T>>

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

type Item = Item

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

Loading content...