[][src]Struct tokio::task::JoinError

pub struct JoinError { /* fields omitted */ }
This is supported on crate feature rt only.

Task failed to execute to completion.

Implementations

impl JoinError[src]

pub fn is_cancelled(&self) -> bool[src]

This is supported on crate feature rt only.

Returns true if the error was caused by the task being cancelled

pub fn is_panic(&self) -> bool[src]

This is supported on crate feature rt only.

Returns true if the error was caused by the task panicking

Examples

use std::panic;

#[tokio::main]
async fn main() {
    let err = tokio::spawn(async {
        panic!("boom");
    }).await.unwrap_err();

    assert!(err.is_panic());
}

pub fn into_panic(self) -> Box<dyn Any + Send + 'static>

Notable traits for Box<F>

impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized
type Output = <F as Future>::Output;
[src]

This is supported on crate feature rt only.

Consumes the join error, returning the object with which the task panicked.

Panics

into_panic() panics if the Error does not represent the underlying task terminating with a panic. Use is_panic to check the error reason or try_into_panic for a variant that does not panic.

Examples

This example panics
use std::panic;

#[tokio::main]
async fn main() {
    let err = tokio::spawn(async {
        panic!("boom");
    }).await.unwrap_err();

    if err.is_panic() {
        // Resume the panic on the main task
        panic::resume_unwind(err.into_panic());
    }
}

pub fn try_into_panic(self) -> Result<Box<dyn Any + Send + 'static>, JoinError>[src]

This is supported on crate feature rt only.

Consumes the join error, returning the object with which the task panicked if the task terminated due to a panic. Otherwise, self is returned.

Examples

This example panics
use std::panic;

#[tokio::main]
async fn main() {
    let err = tokio::spawn(async {
        panic!("boom");
    }).await.unwrap_err();

    if let Ok(reason) = err.try_into_panic() {
        // Resume the panic on the main task
        panic::resume_unwind(reason);
    }
}

Trait Implementations

impl Debug for JoinError[src]

impl Display for JoinError[src]

impl Error for JoinError[src]

impl From<JoinError> for Error[src]

Auto Trait Implementations

Blanket Implementations

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> Instrument for T[src]

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

impl<T> ToString for T where
    T: Display + ?Sized
[src]

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.

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.