Type Alias futures_core::stream::BoxStream

pub type BoxStream<'a, T> = Pin<Box<dyn Stream<Item = T> + Send + 'a>>;

An owned dynamically typed Stream for use in cases where you can’t statically type your result or need to add some indirection.

Aliased Type

struct BoxStream<'a, T> { /* private fields */ }

Trait Implementations

impl<P> Deref for Pin<P>where P: Deref,

type Target = <P as Deref>::Target

The resulting type after dereferencing.

fn deref(&self) -> &<P as Deref>::Target

Dereferences the value.

impl<P> FusedFuture for Pin<P>where P: DerefMut + Unpin, P::Target: FusedFuture,

fn is_terminated(&self) -> bool

Returns true if the underlying future should no longer be polled.

impl<P> FusedStream for Pin<P>where P: DerefMut + Unpin, P::Target: FusedStream,

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<P> Stream for Pin<P>where P: DerefMut + Unpin, P::Target: Stream,

type Item = <<P as Deref>::Target as Stream>::Item

Values yielded by the stream.

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.

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

Returns the bounds on the remaining length of the stream.