Struct futures_core::stream::LocalStreamObj

pub struct LocalStreamObj<'a, T> { /* fields omitted */ }

A custom trait object for polling streams, roughly akin to Box<dyn Stream<Item = T> + 'a>.

This custom trait object was introduced for two reasons:

• Currently it is not possible to take dyn Trait by value and Box<dyn Trait> is not available in no_std contexts.

Methods

impl<'a, T> LocalStreamObj<'a, T>

pub fn new<F: UnsafeStreamObj<'a, T> + 'a>(f: F) -> LocalStreamObj<'a, T>

Create a LocalStreamObj from a custom trait object representation.

pub unsafe fn into_stream_obj(self) -> StreamObj<'a, T>

Converts the LocalStreamObj into a StreamObj To make this operation safe one has to ensure that the UnsafeStreamObj instance from which this LocalStreamObj was created actually implements Send.

Trait Implementations

impl<'a, T> Stream for LocalStreamObj<'a, T>

type Item = T

Values yielded by the stream.

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

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.

impl<'a, T> Unpin for LocalStreamObj<'a, T>

impl<'a, T> From<StreamObj<'a, T>> for LocalStreamObj<'a, T>

fn from(f: StreamObj<'a, T>) -> LocalStreamObj<'a, T>

Performs the conversion.

impl<'a, F: Stream<Item = ()> + 'a> From<Pin<Box<F>>> for LocalStreamObj<'a, ()>

fn from(boxed: Pin<Box<F>>) -> Self

Performs the conversion.

impl<'a, F: Stream<Item = ()> + 'a> From<Box<F>> for LocalStreamObj<'a, ()>

fn from(boxed: Box<F>) -> Self

Performs the conversion.

impl<'a, T> Drop for LocalStreamObj<'a, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T> Debug for LocalStreamObj<'a, T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.