Enum TaskError

pub enum TaskError {
    ExpectedError(String),
    UnexpectedError(String),
    TimeoutError,
    Retry(Option<DateTime<Utc>>),
}

Errors that can occur at the task level.

Variants

ExpectedError(String)

An error that is expected to happen every once in a while.

These errors will only be logged at the WARN level and will always trigger a task retry unless max_retries is set to 0 (or max retries is exceeded).

A typical example is a task that makes an HTTP request to an external service. If that service is temporarily unavailable the task should raise an ExpectedError.

Tasks are always retried with capped exponential backoff.

UnexpectedError(String)

Should be used when a task encounters an error that is unexpected.

These errors will always be logged at the ERROR level. The retry behavior when this error is encountered is determined by the TaskOptions::retry_for_unexpected setting.

TimeoutError

Raised when a task runs over its time limit specified by the TaskOptions::time_limit setting.

These errors are logged at the ERROR level but are otherwise treated like ExpectedErrors in that they will trigger a retry when max_retries is anything but 0.

Typically a task implementation doesn’t need to return these errors directly because they will be raised automatically when the task runs over it’s time_limit, provided the task yields control at some point (like with non-blocking IO).

Retry(Option<DateTime<Utc>>)

A task can return this error variant to manually trigger a retry.

This error variant should generally not be used directly. Instead, you should call the Task::retry_with_countdown or Task::retry_with_eta trait methods to manually trigger a retry from within a task.

Trait Implementations

impl Debug for TaskError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TaskError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TaskError

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

Formats the value using the given formatter.

impl Error for TaskError

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 Serialize for TaskError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.