Struct async_std::task::JoinHandle[−][src]

pub struct JoinHandle<T> { /* fields omitted */ }

A handle that awaits the result of a task.

Dropping a JoinHandle will detach the task, meaning that there is no longer a handle to the task and no way to join on it.

Created when a task is spawned.

Implementations

`impl<T> JoinHandle<T>`[src]

`pub fn task(&self) -> &Task`[src]

Returns a handle to the underlying task.

Examples

use async_std::task;

let handle = task::spawn(async {
    1 + 2
});
println!("id = {}", handle.task().id());

`pub async fn cancel(self) -> Option<T>`[src]

Cancel this task.

Trait Implementations

`impl<T: Debug> Debug for JoinHandle<T>`[src]

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

`impl<T> Drop for JoinHandle<T>`[src]

`fn drop(&mut self)`[src]

`impl<T> Future for JoinHandle<T>`[src]

`type Output = T`

The type of value produced on completion.

`fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>`[src]

Auto Trait Implementations

`impl<T> RefUnwindSafe for JoinHandle<T>`

`impl<T> Send for JoinHandle<T> where T: Send,`

`impl<T> Sync for JoinHandle<T>`

`impl<T> Unpin for JoinHandle<T>`

`impl<T> UnwindSafe for JoinHandle<T>`

Blanket Implementations

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

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

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

`pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut F impl<'_, F> Future for &'_ mut F where F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;`[src]

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

`pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut F impl<'_, F> Future for &'_ mut F where F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;`[src]

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

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

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

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

`pub fn or<F>(self, other: F) -> Or<Self, F>ⓘNotable traits for Or<F1, F2> impl<T, F1, F2> Future for Or<F1, F2> where F1: Future<Output = T>, F2: Future<Output = T>, type Output = T; where F: Future<Output = Self::Output>,` [src]

`pub fn race<F>(self, other: F) -> Race<Self, F>ⓘNotable traits for Race<F1, F2> impl<T, F1, F2> Future for Race<F1, F2> where F1: Future<Output = T>, F2: Future<Output = T>, type Output = T; where F: Future<Output = Self::Output>,` [src]

`pub fn catch_unwind(self) -> CatchUnwind<Self>ⓘNotable traits for CatchUnwind<F> impl<F> Future for CatchUnwind<F> where F: Future + UnwindSafe, type Output = Result<<F as Future>::Output, Box<dyn Any + 'static + Send, Global>>; where Self: UnwindSafe,` [src]

`pub fn boxed<'a>( self ) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>>ⓘNotable traits for Pin impl Future for Pin where P: Unpin + DerefMut, ::Target: Future, type Output = <::Target as Future>::Output; where Self: Send + 'a,` [src]

`pub fn boxed_local<'a>( self ) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>>ⓘNotable traits for Pin impl Future for Pin where P: Unpin + DerefMut, ::Target: Future, type Output = <::Target as Future>::Output; where Self: 'a,` [src]

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

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

`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]

`impl<T, U> TryFrom 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>::Error>`[src]

`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]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

Struct async_std::task::JoinHandle⎘[−][src]

Implementations

impl<T> JoinHandle<T>[src]

pub fn task(&self) -> &Task[src]

Examples

pub async fn cancel(self) -> Option<T>[src]

Trait Implementations

impl<T: Debug> Debug for JoinHandle<T>[src]

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

impl<T> Drop for JoinHandle<T>[src]

fn drop(&mut self)[src]

impl<T> Future for JoinHandle<T>[src]

type Output = T

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

Auto Trait Implementations

impl<T> RefUnwindSafe for JoinHandle<T>

impl<T> Send for JoinHandle<T> where T: Send,

impl<T> Sync for JoinHandle<T>

impl<T> Unpin for JoinHandle<T>

impl<T> UnwindSafe for JoinHandle<T>

Blanket Implementations

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

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

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

pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut Fimpl<'_, F> Future for &'_ mut F where F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;[src]

Notable traits for &'_ mut F

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

pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut Fimpl<'_, F> Future for &'_ mut F where F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;[src]

Notable traits for &'_ mut F

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

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

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

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

pub fn or<F>(self, other: F) -> Or<Self, F>ⓘNotable traits for Or<F1, F2>impl<T, F1, F2> Future for Or<F1, F2> where F1: Future<Output = T>, F2: Future<Output = T>, type Output = T; where F: Future<Output = Self::Output>, [src]

Notable traits for Or<F1, F2>

pub fn race<F>(self, other: F) -> Race<Self, F>ⓘNotable traits for Race<F1, F2>impl<T, F1, F2> Future for Race<F1, F2> where F1: Future<Output = T>, F2: Future<Output = T>, type Output = T; where F: Future<Output = Self::Output>, [src]

Notable traits for Race<F1, F2>

pub fn catch_unwind(self) -> CatchUnwind<Self>ⓘNotable traits for CatchUnwind<F>impl<F> Future for CatchUnwind<F> where F: Future + UnwindSafe, type Output = Result<<F as Future>::Output, Box<dyn Any + 'static + Send, Global>>; where Self: UnwindSafe, [src]

Notable traits for CatchUnwind<F>

pub 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]

Notable traits for Pin<P>

pub 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]

Notable traits for Pin<P>

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

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

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

type Output = <F as Future>::Output

type Future = F

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

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

type Error = Infallible

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

impl<F, T, E> TryFuture for F where F: Future<Output = Result<T, E>> + ?Sized, [src]

type Ok = T

type Error = E

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

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