[][src]Struct futures::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.

Methods

impl<St> StreamFuture<St> where
    St: Unpin + Stream
[src]

pub fn get_ref(&self) -> Option<&St>[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 St>[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 get_pin_mut(self: Pin<&mut StreamFuture<St>>) -> Option<Pin<&mut St>>[src]

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>[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<St> Unpin for StreamFuture<St> where
    St: Unpin + Stream
[src]

impl<St> Debug for StreamFuture<St> where
    St: Debug
[src]

impl<St> FusedFuture for StreamFuture<St> where
    St: Unpin + Stream
[src]

impl<St> Future for StreamFuture<St> where
    St: Unpin + Stream
[src]

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

The type of value produced on completion.

Auto Trait Implementations

impl<St> Send for StreamFuture<St> where
    St: Send

impl<St> Sync for StreamFuture<St> where
    St: Sync

impl<St> UnwindSafe for StreamFuture<St> where
    St: UnwindSafe

impl<St> RefUnwindSafe for StreamFuture<St> where
    St: RefUnwindSafe

Blanket Implementations

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> FutureExt for T where
    T: Future + ?Sized
[src]