Struct futures::future::RemoteHandle [−][src]
#[must_use = "futures do nothing unless you `.await` or poll them"]pub struct RemoteHandle<T> { /* fields omitted */ }
The handle to a remote future returned by
remote_handle. When you drop this,
the remote future will be woken up to be dropped by the executor.
Unwind safety
When the remote future panics, Remote will catch the unwind and transfer it to
the thread where RemoteHandle is being awaited. This is good for the common
case where Remote is spawned on a threadpool. It is unlikely that other code
in the executor working thread shares mutable data with the spawned future and we
preserve the executor from losing its working threads.
If you run the future locally and send the handle of to be awaited elsewhere, you must be careful with regard to unwind safety because the thread in which the future is polled will keep running after the panic and the thread running the RemoteHandle will unwind.
Implementations
impl<T> RemoteHandle<T>[src][−]
pub fn forget(self)[src][−]
Drops this handle without canceling the underlying future.
This method can be used if you want to drop the handle, but let the execution continue.
Trait Implementations
impl<T> Debug for RemoteHandle<T> where
T: Debug, [src][+]
T: Debug,
pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src][−]
Formats the value using the given formatter. Read more
impl<T> Future for RemoteHandle<T> where
T: 'static, [src][+]
T: 'static,
type Output = T
The type of value produced on completion.
pub fn poll(self: Pin<&mut RemoteHandle<T>>, cx: &mut Context<'_>) -> Poll<T>[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<T> !RefUnwindSafe for RemoteHandle<T>
impl<T> Send for RemoteHandle<T> where
T: Send,
T: Send,
impl<T> Sync for RemoteHandle<T> where
T: Send,
T: Send,
impl<T> Unpin for RemoteHandle<T>
impl<T> !UnwindSafe for RemoteHandle<T>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src][+]
T: 'static + ?Sized,
pub fn type_id(&self) -> TypeId[src][−]
Gets the TypeId of self. Read more
impl<T> Borrow<T> for T where
T: ?Sized, [src][+]
T: ?Sized,
pub fn borrow(&self) -> &Tⓘ[src][−]
Immutably borrows from an owned value. Read more
impl<T> BorrowMut<T> for T where
T: ?Sized, [src][+]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut Tⓘ[src][−]
Mutably borrows from an owned value. Read more
impl<T> From<T> for T[src][+]
impl<T> FutureExt for T where
T: Future + ?Sized, [src][+]
T: Future + ?Sized,
pub fn map<U, F>(self, f: F) -> Map<Self, F>ⓘ where
F: FnOnce(Self::Output) -> U, [src][−]
F: FnOnce(Self::Output) -> U,
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][−]
Self::Output: Into<U>,
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>ⓘ where
F: FnOnce(Self::Output) -> Fut,
Fut: Future, [src][−]
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
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][−]
B: Future<Output = Self::Output>,
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][−]
A: Future<Output = Self::Output>,
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][−]
Self::Output: Future,
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][−]
Self::Output: Stream,
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][−]
F: FnOnce(&Self::Output),
Do something with the output of a future before passing it on. Read more
pub 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][−]
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>>;Self: UnwindSafe,
Catches unwinding panics while polling the future. Read more
pub fn shared(self) -> Shared<Self>ⓘ where
Self::Output: Clone, [src][−]
Self::Output: Clone,
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][−]
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>>ⓘ where
Self: Send + 'a,
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][−]
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>>ⓘ where
Self: 'a,
Wrap the future in a Box, pinning it. Read more
pub fn unit_error(self) -> UnitError<Self>ⓘ[src][−]
Turns a Future<Output = T> into a
TryFuture<Ok = T, Error = ()>. Read more
pub 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][−]
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
pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin, [src][−]
Self: Unpin,
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][+]
U: From<T>,
impl<F> IntoFuture for F where
F: Future, [src][+]
F: Future,
type Output = <F as Future>::Output
into_future)The output that the future will produce on completion.
type Future = F
into_future)Which kind of future are we turning this into?
pub fn into_future(self) -> <F as IntoFuture>::Future[src][−]
into_future)Creates a future from a value.
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src][+]
U: Into<T>,
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<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized, [src][+]
F: Future<Output = Result<T, E>> + ?Sized,
type Ok = T
The type of successful values yielded by this future
type Error = E
The type of failures yielded by this future
pub fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>[src][−]
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>
Poll this TryFuture as if it were a Future. Read more
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized, [src][+]
Fut: TryFuture + ?Sized,
pub fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok> where
Self::Ok: Sink<Item>,
<Self::Ok as Sink<Item>>::Error == Self::Error, [src][−]
Self::Ok: Sink<Item>,
<Self::Ok as Sink<Item>>::Error == Self::Error,
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][−]
F: FnOnce(Self::Ok) -> T,
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][−]
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;E: FnOnce(Self::Error) -> T,
F: FnOnce(Self::Ok) -> T,
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][−]
F: FnOnce(Self::Error) -> E,
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][−]
Self::Error: Into<E>,
pub fn ok_into<U>(self) -> OkInto<Self, U>ⓘ where
Self::Ok: Into<U>, [src][−]
Self::Ok: Into<U>,
pub fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F>ⓘ where
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>, [src][−]
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,
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>ⓘ where
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>, [src][−]
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,
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][−]
F: FnOnce(&Self::Ok),
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>ⓘNotable traits for InspectErr<Fut, F>
impl<Fut, F> Future for InspectErr<Fut, F> where
Inspect<IntoFuture<Fut>, InspectErrFn<F>>: Future, type Output = <Inspect<IntoFuture<Fut>, InspectErrFn<F>> as Future>::Output; where
F: FnOnce(&Self::Error), [src][−]
Notable traits for InspectErr<Fut, F>
impl<Fut, F> Future for InspectErr<Fut, F> where
Inspect<IntoFuture<Fut>, InspectErrFn<F>>: Future, type Output = <Inspect<IntoFuture<Fut>, InspectErrFn<F>> as Future>::Output;F: FnOnce(&Self::Error),
Do something with the error value of a future before passing it on. Read more
pub fn try_flatten(self) -> TryFlatten<Self, Self::Ok>ⓘNotable traits for TryFlatten<Fut1, Fut2>
impl<Fut1, Fut2> Future for TryFlatten<Fut1, Fut2> where
TryFlatten<Fut1, Fut2>: Future, type Output = <TryFlatten<Fut1, Fut2> as Future>::Output; where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error, [src][−]
Notable traits for TryFlatten<Fut1, Fut2>
impl<Fut1, Fut2> Future for TryFlatten<Fut1, Fut2> where
TryFlatten<Fut1, Fut2>: Future, type Output = <TryFlatten<Fut1, Fut2> as Future>::Output;Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
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][−]
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,
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>ⓘNotable traits for UnwrapOrElse<Fut, F>
impl<Fut, F> Future for UnwrapOrElse<Fut, F> where
Map<IntoFuture<Fut>, UnwrapOrElseFn<F>>: Future, type Output = <Map<IntoFuture<Fut>, UnwrapOrElseFn<F>> as Future>::Output; where
F: FnOnce(Self::Error) -> Self::Ok, [src][−]
Notable traits for UnwrapOrElse<Fut, F>
impl<Fut, F> Future for UnwrapOrElse<Fut, F> where
Map<IntoFuture<Fut>, UnwrapOrElseFn<F>>: Future, type Output = <Map<IntoFuture<Fut>, UnwrapOrElseFn<F>> as Future>::Output;F: FnOnce(Self::Error) -> Self::Ok,
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>ⓘNotable traits for IntoFuture<Fut>
impl<Fut> Future for IntoFuture<Fut> where
Fut: TryFuture, type Output = Result<<Fut as TryFuture>::Ok, <Fut as TryFuture>::Error>;[src][−]
Notable traits for IntoFuture<Fut>
impl<Fut> Future for IntoFuture<Fut> where
Fut: TryFuture, type Output = Result<<Fut as TryFuture>::Ok, <Fut as TryFuture>::Error>;pub fn try_poll_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>> where
Self: Unpin, [src][−]
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>> where
Self: Unpin,
A convenience method for calling TryFuture::try_poll on Unpin
future types. Read more
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src][+]
U: TryFrom<T>,