Struct futures::future::RemoteHandle[−][src]

#[must_use = "dropping a remote handle cancels the underlying future"]
pub struct RemoteHandle<T> { /* fields omitted */ }
Expand description

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]

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]

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, 

impl<T> Sync for RemoteHandle<T> where
    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]

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<F, T, E> TryFuture for F where
    F: Future<Output = Result<T, E>> + ?Sized, [src]

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]

Poll this TryFuture as if it were a Future. Read more

impl<Fut> TryFutureExt for Fut where
    Fut: TryFuture + ?Sized, [src]

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

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F>ⓘ

Notable traits for MapOk<Fut, F>

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

Maps this future’s success value to a different value. Read more

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

fn map_err<E, F>(self, f: F) -> MapErr<Self, F>ⓘ

Notable traits for MapErr<Fut, F>

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

Maps this future’s error value to a different value. Read more

fn err_into<E>(self) -> ErrInto<Self, E>ⓘ

Notable traits for ErrInto<Fut, E>

impl<Fut, E> Future for ErrInto<Fut, E> where
    MapErr<Fut, IntoFn<E>>: Future,  type Output = <MapErr<Fut, IntoFn<E>> as Future>::Output;
 where
    Self::Error: Into<E>, [src]

Maps this future’s Error to a new error type using the Into trait. Read more

fn ok_into<U>(self) -> OkInto<Self, U>ⓘ

Notable traits for OkInto<Fut, E>

impl<Fut, E> Future for OkInto<Fut, E> where
    MapOk<Fut, IntoFn<E>>: Future,  type Output = <MapOk<Fut, IntoFn<E>> as Future>::Output;
 where
    Self::Ok: Into<U>, [src]

Maps this future’s Ok to a new type using the Into trait. Read more

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

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

fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F>ⓘ

Notable traits for InspectOk<Fut, F>

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

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

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]

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

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]

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

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

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]

Unwraps this future’s output, producing a future with this future’s Ok type as its Output type. Read more

fn compat(self) -> Compat<Self>ⓘ

Notable traits for Compat<R>

impl<R> Read for Compat<R> where
    R: AsyncRead + Unpin, impl<W> Write for Compat<W> where
    W: AsyncWrite + Unpin, 
 where
    Self: Unpin, [src]

Wraps a TryFuture into a future compatible with libraries using futures 0.1 future definitions. Requires the compat feature to enable. Read more

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]

Wraps a TryFuture into a type that implements Future. Read more

fn try_poll_unpin(
    &mut self,
    cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>> where
    Self: Unpin, [src]

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]

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.