impl JoinError

fn is_cancelled(&self) -> bool

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

See the module level docs for more information on cancellation.

fn is_panic(&self) -> bool

Returns true if the error was caused by the task panicking.

Examples

# #[cfg(not(target_family = "wasm"))]
# {
use std::panic;

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

    assert!(err.is_panic());
}
# }

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

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

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());
    }
}

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

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

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);
    }
}

fn id(&self) -> Id

Returns a task ID that identifies the task which errored relative to other currently spawned tasks.