Struct futures_util::stream::StreamFuture

#[must_use = "futures do nothing unless you `.await` or poll them"]pub struct StreamFuture<St> { /* fields omitted */ }

Future for the into_future method.

Implementations

impl<St: Stream + Unpin> StreamFuture<St>

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

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 St>

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 get_pin_mut(self: Pin<&mut Self>) -> Option<Pin<&mut St>>

Acquires a pinned 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<St>

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<St: Debug> Debug for StreamFuture<St>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<St: Stream + Unpin> FusedFuture for StreamFuture<St>

pub fn is_terminated(&self) -> bool

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

impl<St: Stream + Unpin> Future for StreamFuture<St>

type Output = (Option<St::Item>, St)

The type of value produced on completion.

pub fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

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