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

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

Future for the into_future method.

Implementations

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

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

Formats the value using the given formatter. Read more

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

pub fn is_terminated(&self) -> bool[src]

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

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

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

The type of value produced on completion.

pub fn poll(
    self: Pin<&mut StreamFuture<St>>,
    cx: &mut Context<'_>
) -> Poll<<StreamFuture<St> as Future>::Output>[src]

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

Auto Trait Implementations

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

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

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

impl<St> Unpin for StreamFuture<St> where
    St: Unpin, 

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

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

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

pub fn from(t: T) -> T[src]

Performs the conversion.

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

fn map<U, F>(self, f: F) -> Map<Self, F>ⓘ

Notable traits for Map<Fut, F>

impl<Fut, F> Future for Map<Fut, F> where
    Map<Fut, F>: Future,  type Output = <Map<Fut, F> as Future>::Output;
 where
    F: FnOnce(Self::Output) -> U, [src]

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

fn map_into<U>(self) -> MapInto<Self, U>ⓘ

Notable traits for MapInto<Fut, T>

impl<Fut, T> Future for MapInto<Fut, T> where
    Map<Fut, IntoFn<T>>: Future,  type Output = <Map<Fut, IntoFn<T>> as Future>::Output;
 where
    Self::Output: Into<U>, [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>ⓘ

Notable traits for Then<Fut1, Fut2, F>

impl<Fut1, Fut2, F> Future for Then<Fut1, Fut2, F> where
    Flatten<Map<Fut1, F>, Fut2>: Future,  type Output = <Flatten<Map<Fut1, F>, Fut2> as Future>::Output;
 where
    F: FnOnce(Self::Output) -> Fut,
    Fut: Future, [src]

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

fn left_future<B>(self) -> Either<Self, B>ⓘ

Notable traits for Either<A, B>

impl<A, B> Future for Either<A, B> where
    B: Future<Output = <A as Future>::Output>,
    A: Future,  type Output = <A as Future>::Output;
 where
    B: Future<Output = Self::Output>, [src]

Wrap this future in an Either future, making it the left-hand variant of that Either. Read more

fn right_future<A>(self) -> Either<A, Self>ⓘ

Notable traits for Either<A, B>

impl<A, B> Future for Either<A, B> where
    B: Future<Output = <A as Future>::Output>,
    A: Future,  type Output = <A as Future>::Output;
 where
    A: Future<Output = Self::Output>, [src]

Wrap this future in an Either future, making it the right-hand variant of that Either. Read more

fn into_stream(self) -> IntoStream<Self>[src]

Convert this future into a single element stream. Read more

fn flatten(self) -> Flatten<Self>ⓘ

Notable traits for Flatten<F>

impl<F> Future for Flatten<F> where
    F: Future,
    Flatten<F, <F as Future>::Output>: Future,  type Output = <Flatten<F, <F as Future>::Output> as Future>::Output;
 where
    Self::Output: Future, [src]

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

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

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

fn fuse(self) -> Fuse<Self>ⓘ

Notable traits for Fuse<Fut>

impl<Fut> Future for Fuse<Fut> where
    Fut: Future,  type Output = <Fut as Future>::Output;
[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>ⓘ

Notable traits for Inspect<Fut, F>

impl<Fut, F> Future for Inspect<Fut, F> where
    Map<Fut, InspectFn<F>>: Future,  type Output = <Map<Fut, InspectFn<F>> as Future>::Output;
 where
    F: FnOnce(&Self::Output), [src]

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

fn catch_unwind(self) -> CatchUnwind<Self>ⓘ

Notable traits for CatchUnwind<Fut>

impl<Fut> Future for CatchUnwind<Fut> where
    Fut: Future + UnwindSafe,  type Output = Result<<Fut as Future>::Output, Box<dyn Any + 'static + Send, Global>>;
 where
    Self: UnwindSafe, [src]

Catches unwinding panics while polling the future. Read more

fn shared(self) -> Shared<Self>ⓘ

Notable traits for Shared<Fut>

impl<Fut> Future for Shared<Fut> where
    Fut: Future,
    <Fut as Future>::Output: Clone,  type Output = <Fut as Future>::Output;
 where
    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>)[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<'a>(
    self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>>ⓘ

Notable traits for Pin<P>

impl<P> Future for Pin<P> where
    P: Unpin + DerefMut,
    <P as Deref>::Target: Future,  type Output = <<P as Deref>::Target as Future>::Output;
 where
    Self: Send + 'a, [src]

Wrap the future in a Box, pinning it. Read more

fn boxed_local<'a>(
    self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>>ⓘ

Notable traits for Pin<P>

impl<P> Future for Pin<P> where
    P: Unpin + DerefMut,
    <P as Deref>::Target: Future,  type Output = <<P as Deref>::Target as Future>::Output;
 where
    Self: 'a, [src]

Wrap the future in a Box, pinning it. Read more

fn unit_error(self) -> UnitError<Self>ⓘ

Notable traits for UnitError<Fut>

impl<Fut> Future for UnitError<Fut> where
    Map<Fut, OkFn<()>>: Future,  type Output = <Map<Fut, OkFn<()>> as Future>::Output;
[src]

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = ()>. Read more

fn never_error(self) -> NeverError<Self>ⓘ

Notable traits for NeverError<Fut>

impl<Fut> Future for NeverError<Fut> where
    Map<Fut, OkFn<Infallible>>: Future,  type Output = <Map<Fut, OkFn<Infallible>> as Future>::Output;
[src]

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = Never>. Read more

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
    Self: Unpin, [src]

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

fn now_or_never(self) -> Option<Self::Output>[src]

Evaluates and consumes the future, returning the resulting output if the future is ready after the first call to Future::poll. Read more

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

pub fn into(self) -> U[src]

Performs the conversion.

impl<F> IntoFuture for F where
    F: Future, [src]

type Output = <F as Future>::Output

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

The output that the future will produce on completion.

type Future = F

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

Which kind of future are we turning this into?

pub fn into_future(self) -> <F as IntoFuture>::Future[src]

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

Creates a future from a value.

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.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

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.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.