Enum TaskError 

pub enum TaskError<E> {
    Fsm(E),
    Join(JoinError),
}

Error type returned by the FSM background task.

This enum distinguishes between logical errors returned by your FSM handlers and runtime failures of the Tokio task itself (for example, panics or task aborts).

Type Parameters

• E: The logical error type defined in your impl block via type Error = ...;.

Examples

use tokio_fsm::TaskError;

// Example of a match against a task's result
match task.await {
    Ok(final_context) => println!("FSM finished normally."),
    Err(TaskError::Fsm(e)) => println!("FSM aborted with a logical error: {}", e),
    Err(TaskError::Join(e)) => println!("Tokio task failed (e.g. panicked): {}", e),
}

Variants

Fsm(E)

The FSM handler returned a logical error, triggering a shutdown.

This variant is used when your FSM handler returns Result::Err(...).

Join(JoinError)

The background task failed due to a panic or explicit task abort.

This wraps a tokio::task::JoinError.

Trait Implementations

impl<E: Debug> Debug for TaskError<E>

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

Formats the value using the given formatter.

impl<E> Display for TaskError<E>

where E: Display,

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

Formats the value using the given formatter.

impl<E> Error for TaskError<E>

where Self: Debug + Display,

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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.

impl<E> From<JoinError> for TaskError<E>

fn from(source: JoinError) -> Self

Converts to this type from the input type.