#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct Fuse<Fut> { /* fields omitted */ }
Future for the fuse
method.
Creates a new Fuse
-wrapped future which is already terminated.
This can be useful in combination with looping and the select!
macro, which bypasses terminated futures.
use futures::channel::mpsc;
use futures::future::{Fuse, FusedFuture, FutureExt};
use futures::select;
use futures::stream::StreamExt;
use futures::pin_mut;
let (sender, mut stream) = mpsc::unbounded();
sender.unbounded_send(()).unwrap();
sender.unbounded_send(()).unwrap();
drop(sender);
let foo_printer = Fuse::terminated();
pin_mut!(foo_printer);
loop {
select! {
_ = foo_printer => {},
() = stream.select_next_some() => {
if !foo_printer.is_terminated() {
println!("Foo is already being printed!");
} else {
foo_printer.set(async {
println!("Printing foo from `foo_printer` future");
}.fuse());
}
},
complete => break,
}
}
impl<T> Any for T where
T: 'static + ?Sized,
[src][+]
impl<T> Borrow<T> for T where
T: ?Sized,
[src][+]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src][+]
impl<T> From<T> for T
[src][+]
impl<T> FutureExt for T where
T: Future + ?Sized,
[src][+]
[+] Show hidden undocumented itemspub fn map<U, F>(self, f: F) -> Map<Self, F>ⓘ 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
pub fn map_into<U>(self) -> MapInto<Self, U>ⓘ 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
pub 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
pub fn left_future<B>(self) -> Either<Self, B>ⓘ 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
pub fn right_future<A>(self) -> Either<A, Self>ⓘ 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
pub fn into_stream(self) -> IntoStream<Self>
[src][−]
Convert this future into a single element stream. Read more
pub fn flatten(self) -> Flatten<Self>ⓘ where
Self::Output: Future,
[src][−]
Flatten the execution of this future when the output of this
future is itself another future. Read more
pub 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
pub fn fuse(self) -> Fuse<Self>ⓘ
[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
pub fn inspect<F>(self, f: F) -> Inspect<Self, F>ⓘ where
F: FnOnce(&Self::Output),
[src][−]
Do something with the output of a future before passing it on. Read more
pub fn catch_unwind(self) -> CatchUnwind<Self>ⓘ where
Self: UnwindSafe,
[src][−]
Catches unwinding panics while polling the future. Read more
pub fn shared(self) -> Shared<Self>ⓘ where
Self::Output: Clone,
[src][−]
Create a cloneable handle to this future where all handles will resolve
to the same result. Read more
pub 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
pub fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>>ⓘ where
Self: Send + 'a,
[src][−]
Wrap the future in a Box, pinning it. Read more
pub fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>>ⓘ where
Self: 'a,
[src][−]
Wrap the future in a Box, pinning it. Read more
pub fn unit_error(self) -> UnitError<Self>ⓘ
[src][−]
pub fn never_error(self) -> NeverError<Self>ⓘ
[src][−]
pub 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.
pub 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][+]
impl<F> IntoFuture for F where
F: Future,
[src][+]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src][+]
impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,
[src][+]
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized,
[src][+]
[+] Show hidden undocumented itemspub fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok> where
Self::Ok: Sink<Item>,
<Self::Ok as Sink<Item>>::Error == Self::Error,
[src][−]
Flattens the execution of this future when the successful result of this
future is a Sink
. Read more
pub fn map_ok<T, F>(self, f: F) -> MapOk<Self, F>ⓘ where
F: FnOnce(Self::Ok) -> T,
[src][−]
Maps this future’s success value to a different value. Read more
pub fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E>ⓘNotable traits for MapOkOrElse<Fut, F, G>
impl<Fut, F, G> Future for MapOkOrElse<Fut, F, G> where
Map<IntoFuture<Fut>, ChainFn<MapOkFn<F>, ChainFn<MapErrFn<G>, MergeResultFn>>>: Future, type Output = <Map<IntoFuture<Fut>, ChainFn<MapOkFn<F>, ChainFn<MapErrFn<G>, MergeResultFn>>> as Future>::Output;
where
E: FnOnce(Self::Error) -> T,
F: FnOnce(Self::Ok) -> T,
[src][−]
Maps this future’s success value to a different value, and permits for error handling resulting in the same type. Read more
pub fn map_err<E, F>(self, f: F) -> MapErr<Self, F>ⓘ where
F: FnOnce(Self::Error) -> E,
[src][−]
Maps this future’s error value to a different value. Read more
pub fn err_into<E>(self) -> ErrInto<Self, E>ⓘ where
Self::Error: Into<E>,
[src][−]
pub fn ok_into<U>(self) -> OkInto<Self, U>ⓘ where
Self::Ok: Into<U>,
[src][−]
pub fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F>ⓘNotable traits for AndThen<Fut1, Fut2, F>
impl<Fut1, Fut2, F> Future for AndThen<Fut1, Fut2, F> where
TryFlatten<MapOk<Fut1, F>, Fut2>: Future, type Output = <TryFlatten<MapOk<Fut1, F>, Fut2> as Future>::Output;
where
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,
[src][−]
Executes another future after this one resolves successfully. The
success value is passed to a closure to create this subsequent future. Read more
pub fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F>ⓘNotable traits for OrElse<Fut1, Fut2, F>
impl<Fut1, Fut2, F> Future for OrElse<Fut1, Fut2, F> where
TryFlattenErr<MapErr<Fut1, F>, Fut2>: Future, type Output = <TryFlattenErr<MapErr<Fut1, F>, Fut2> as Future>::Output;
where
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,
[src][−]
Executes another future if this one resolves to an error. The
error value is passed to a closure to create this subsequent future. Read more
pub fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F>ⓘ where
F: FnOnce(&Self::Ok),
[src][−]
Do something with the success value of a future before passing it on. Read more
pub fn inspect_err<F>(self, f: F) -> InspectErr<Self, F>ⓘ where
F: FnOnce(&Self::Error),
[src][−]
Do something with the error value of a future before passing it on. Read more
pub fn try_flatten(self) -> TryFlatten<Self, Self::Ok>ⓘ where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
[src][−]
Flatten the execution of this future when the successful result of this
future is another future. Read more
pub fn try_flatten_stream(self) -> TryFlattenStream<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,
[src][−]
Flatten the execution of this future when the successful result of this
future is a stream. Read more
pub fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F>ⓘ where
F: FnOnce(Self::Error) -> Self::Ok,
[src][−]
Unwraps this future’s output, producing a future with this future’s
Ok
type as its
Output
type. Read more
pub fn into_future(self) -> IntoFuture<Self>ⓘ
[src][−]
pub fn try_poll_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>> where
Self: Unpin,
[src][−]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src][+]