actix_rt::task

# Struct JoinError

    pub struct JoinError { /* private fields */ }

Expand description

Task failed to execute to completion.

## Implementations§

§

### impl JoinError

#### pub 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.

#### pub fn is_panic(&self) -> bool

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>

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

#### pub fn try_into_panic(self) -> Result<Box<dyn Any + Send>, 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);
        }
    }

## Trait Implementations§

§

### impl Debug for JoinError

§

#### fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
§

### impl Display for JoinError

§

#### fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
§

### impl Error for JoinError

1.81.0 · source §

#### fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.81.0 · source §

#### fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.81.0 · source §

#### fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source §

#### fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (`error_generic_member_access`)
Provides type-based access to context intended for error reports. Read more

## Auto Trait Implementations§

§

### impl Freeze for JoinError

§

### impl !RefUnwindSafe for JoinError

§

### impl Send for JoinError

§

### impl Sync for JoinError

§

### impl Unpin for JoinError

§

### impl !UnwindSafe for JoinError

## Blanket Implementations§

source §

### impl<T> Any for T
where T: 'static + ?Sized,

source §

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source §

### impl<T> Borrow<T> for T
where T: ?Sized,

source §

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source §

### impl<T> BorrowMut<T> for T
where T: ?Sized,

source §

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source §

### impl<T> From<T> for T

source §

#### fn from(t: T) -> T

Returns the argument unchanged.

source §

### impl<T, U> Into<U> for T
where U: From<T>,

source §

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source §

### impl<T> ToString for T
where T: Display + ?Sized,

source §

#### default fn to_string(&self) -> String

Converts the given value to a `String`. Read more
source §

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

source §

#### type Error = Infallible

The type returned in the event of a conversion error.
source §

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source §

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source §

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

The type returned in the event of a conversion error.
source §

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.