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

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

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

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

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

futures in libcore are unstable

The result of the Future.

impl<St> FusedFuture for StreamFuture<St>[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> FutureExt for T where
    T: Future + ?Sized, [src]

fn map<U, F>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Output) -> U,
    Self: Sized, [src]

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

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
    F: FnOnce(Self::Output) -> Fut,
    Fut: Future,
    Self: Sized, [src]

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

fn join<Fut2>(self, other: Fut2) -> Join<Self, Fut2> where
    Fut2: Future,
    Self: Sized, [src]

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

fn join3<Fut2, Fut3>(
    self,
    future2: Fut2,
    future3: Fut3
) -> Join3<Self, Fut2, Fut3> where
    Fut2: Future,
    Fut3: Future,
    Self: Sized, [src]

Same as join, but with more futures. Read more

fn join4<Fut2, Fut3, Fut4>(
    self,
    future2: Fut2,
    future3: Fut3,
    future4: Fut4
) -> Join4<Self, Fut2, Fut3, Fut4> where
    Fut2: Future,
    Fut3: Future,
    Fut3: Future,
    Fut4: Future,
    Self: Sized, [src]

Same as join, but with more futures. Read more

fn join5<Fut2, Fut3, Fut4, Fut5>(
    self,
    future2: Fut2,
    future3: Fut3,
    future4: Fut4,
    future5: Fut5
) -> Join5<Self, Fut2, Fut3, Fut4, Fut5> where
    Fut2: Future,
    Fut3: Future,
    Fut3: Future,
    Fut4: Future,
    Fut5: Future,
    Self: Sized, [src]

Same as join, but with more futures. Read more

fn into_stream(self) -> IntoStream<Self> where
    Self: Sized, [src]

Convert this future into a single element stream. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Output: Future,
    Self: Sized, [src]

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

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Output: Stream,
    Self: Sized, [src]

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

fn fuse(self) -> Fuse<Self> where
    Self: Sized, [src]

Fuse a future such that poll will never again be called once it has completed. This method can be used to turn any Future into a FusedFuture. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Output),
    Self: Sized, [src]

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

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: Sized + UnwindSafe, [src]

Catches unwinding panics while polling the future. Read more

fn shared(self) -> Shared<Self> where
    Self: Sized,
    Self::Output: Clone, [src]

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

fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>) where
    Self: Sized, [src]

Turn this future into a future that yields () on completion and sends its output to another future on a separate task. Read more

fn boxed(self) -> Pin<Box<Self>> where
    Self: Sized, [src]

Wrap the future in a Box, pinning it.

fn unit_error(self) -> UnitError<Self> where
    Self: Sized, [src]

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

fn poll_unpin(&mut self, lw: &LocalWaker) -> Poll<Self::Output> where
    Self: Unpin + Sized, [src]

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

impl<T> From for T[src]

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

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

type Error = !

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

The type returned in the event of a conversion error.

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

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

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

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

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

The type returned in the event of a conversion error.

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