Struct futures::stream::StreamFuture

#[must_use = "futures do nothing unless polled"]
pub struct StreamFuture<S> { /* fields omitted */ }

A combinator used to temporarily convert a stream into a future.

This future is returned by the Stream::next method.

Methods

impl<S> StreamFuture<S>

pub fn get_ref(&self) -> Option<&S>

Acquires a reference to the underlying stream that this combinator is pulling from.

This method returns an Option to account for the fact that StreamFuture's implementation of Future::poll consumes the underlying stream during polling in order to return it to the caller of Future::poll if the stream yielded an element.

pub fn get_mut(&mut self) -> Option<&mut S>

Acquires a mutable reference to the underlying stream that this combinator is pulling from.

Note that care must be taken to avoid tampering with the state of the stream which may otherwise confuse this combinator.

This method returns an Option to account for the fact that StreamFuture's implementation of Future::poll consumes the underlying stream during polling in order to return it to the caller of Future::poll if the stream yielded an element.

pub fn into_inner(self) -> Option<S>

Consumes this combinator, returning the underlying stream.

Note that this may discard intermediate state of this combinator, so care should be taken to avoid losing resources when this is called.

This method returns an Option to account for the fact that StreamFuture's implementation of Future::poll consumes the underlying stream during polling in order to return it to the caller of Future::poll if the stream yielded an element.

Trait Implementations

impl<S> Debug for StreamFuture<S> where
    S: Debug, 

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<S> Future for StreamFuture<S> where
    S: Stream, 

type Item = (Option<<S as Stream>::Item>, S)

A successful value

type Error = (<S as Stream>::Error, S)

An error

fn poll(
    &mut self,
    cx: &mut Context
) -> Result<Async<<StreamFuture<S> as Future>::Item>, <StreamFuture<S> as Future>::Error>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.