Struct futures::stream::StreamFuture [−][src]
pub struct StreamFuture<St> { /* fields omitted */ }Expand description
Future for the into_future method.
Implementations
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.
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.
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
Returns true if the underlying future should no longer be polled.
pub fn poll(
self: Pin<&mut StreamFuture<St>>,
cx: &mut Context<'_>
) -> Poll<<StreamFuture<St> as Future>::Output>
pub fn poll(
self: Pin<&mut StreamFuture<St>>,
cx: &mut Context<'_>
) -> Poll<<StreamFuture<St> as Future>::Output>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
Mutably borrows from an owned value. Read more
Map this future’s output to a different type, returning a new future of the resulting type. Read more
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
Wrap this future in an Either future, making it the left-hand variant
of that Either. Read more
Wrap this future in an Either future, making it the right-hand variant
of that Either. Read more
Convert this future into a single element stream. Read more
Flatten the execution of this future when the output 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. This method can be used to turn any Future into a
FusedFuture. Read more
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 + Send + 'static, Global>>; where
Self: UnwindSafe,
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 + Send + 'static, Global>>; where
Self: UnwindSafe, 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
Turn this future into a future that yields () on completion and sends
its output to another future on a separate task. Read more
Wrap the future in a Box, pinning it. Read more
Wrap the future in a Box, pinning it. Read more
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;
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;Turns a Future<Output = T> into a
TryFuture<Ok = T, Error = Never>. Read more
A convenience for calling Future::poll on Unpin future types.
Evaluates and consumes the future, returning the resulting output if
the future is ready after the first call to Future::poll. Read more
into_future)The output that the future will produce on completion.
type Future = F
type Future = Finto_future)Which kind of future are we turning this into?
into_future)Creates a future from a value.