[][src]Struct futures::stream::StreamFuture

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

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

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

Methods

impl<St> StreamFuture<St> where
    St: Unpin + Stream
[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.

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.

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

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

The result of the Future.

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

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

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

Formats the value using the given formatter. Read more

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

Auto Trait Implementations

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

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

Blanket Implementations

impl<T> From for T
[src]

Performs the conversion.

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

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

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

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

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

Performs the conversion.

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

Important traits for &'a mut I

Immutably borrows from an owned value. Read more

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

Important traits for &'a mut I

Mutably borrows from an owned value. Read more

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

🔬 This is a nightly-only experimental API. (get_type_id)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

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

Map this future's output to a different type, returning a new future of the resulting type. Read more

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

Joins the result of two futures, waiting for them both to complete. Read more

Same as join, but with more futures. Read more

Same as join, but with more futures. Read more

Same as join, but with more futures. Read more

Convert this future into a single element stream. Read more

Flatten the execution of this future when the successful result of this future is itself another future. Read more

Flatten the execution of this future when the successful result of this future is a stream. Read more

Fuse a future such that poll will never again be called once it has completed. Read more

Do something with the output of a future before passing it on. Read more

Catches unwinding panics while polling the future. Read more

Create a cloneable handle to this future where all handles will resolve to the same result. Read more

Wrap the future in a Box, pinning it.

Turns a Future into a TryFuture with Error = ().

Assigns the provided Spawn to be used when spawning tasks from within the future. Read more

A convenience for calling Future::poll on Unpin future types.