Struct futures_util::stream::StreamFuture
[−]
[src]
#[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>
[src]
pub fn get_ref(&self) -> Option<&S>
[src]
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>
[src]
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>
[src]
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> Debug for StreamFuture<S>
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<S: Stream> Future for StreamFuture<S>
[src]
Auto Trait Implementations
impl<S> Send for StreamFuture<S> where
S: Send,
S: Send,
impl<S> Sync for StreamFuture<S> where
S: Sync,
S: Sync,