Skip to main content

TaskError

Enum TaskError 

Source
#[non_exhaustive]
pub enum TaskError { ExecutionFailed(String),
#[non_exhaustive]
Timeout { timeout: Duration, }, Canceled, HeartbeatFailed(String),
#[non_exhaustive]
HeartbeatTimeout { timeout: Duration, },
#[non_exhaustive]
NotFound { task_id: String, },
#[non_exhaustive]
AlreadyCompleted { task_id: String, }, Panic(String),
#[non_exhaustive]
RetryLimitExceeded { attempts: u32, }, InvalidInput(String), InvalidConfiguration(String),
#[non_exhaustive]
Application { error_type: String, message: String, non_retryable: bool, }, }
Expand description

Errors that can occur during task execution.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

ExecutionFailed(String)

Task execution failed

Tuple Fields

§0: String

Description of the execution failure

§

#[non_exhaustive]
Timeout

Task timed out

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§timeout: Duration

The timeout duration that was exceeded

§

Canceled

Task was canceled

§

HeartbeatFailed(String)

Heartbeat failed

Tuple Fields

§0: String

Details about the heartbeat failure

§

#[non_exhaustive]
HeartbeatTimeout

Heartbeat timeout (no heartbeat received)

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§timeout: Duration

The timeout duration that was exceeded

§

#[non_exhaustive]
NotFound

Task not found

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§task_id: String

The ID of the task that was not found

§

#[non_exhaustive]
AlreadyCompleted

Task already completed

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§task_id: String

The ID of the task that was already completed

§

Panic(String)

Task panic

Tuple Fields

§0: String

The panic message

§

#[non_exhaustive]
RetryLimitExceeded

Retry limit exceeded

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§attempts: u32

Number of retry attempts that were made

§

InvalidInput(String)

Invalid task input

Tuple Fields

§0: String

Description of the invalid input

§

InvalidConfiguration(String)

Invalid task configuration

Tuple Fields

§0: String

Description of the configuration error

§

#[non_exhaustive]
Application

A failure the task’s own code names, reported to the engine under error_type so a retry policy’s non-retryable list can match it. Build one with TaskError::application or TaskError::non_retryable.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§error_type: String

The name a retry policy lists the failure under.

§message: String

What went wrong.

§non_retryable: bool

No retry can succeed: the engine does not retry the task, whatever its policy allows.

Implementations§

Source§

impl TaskError

Source

pub fn execution_failed(reason: impl Into<String>) -> Self

Create an execution failed error

Source

pub fn heartbeat_failed(reason: impl Into<String>) -> Self

Create a heartbeat failed error

Source

pub fn timeout(timeout: Duration) -> Self

Create a timeout error

Source

pub fn not_found(task_id: impl Into<String>) -> Self

Create a not found error

Source

pub fn retry_limit_exceeded(attempts: u32) -> Self

Create a retry limit exceeded error

Source

pub fn heartbeat_timeout(timeout: Duration) -> Self

Create a heartbeat timeout error

Source

pub fn already_completed(task_id: impl Into<String>) -> Self

Create a task already completed error

Source

pub fn invalid_input(reason: impl Into<String>) -> Self

Create an invalid input error

Source

pub fn application( error_type: impl Into<String>, message: impl Into<String>, ) -> Self

A failure of type error_type, retried unless the task’s retry policy lists that type as non-retryable.

Source

pub fn non_retryable( error_type: impl Into<String>, message: impl Into<String>, ) -> Self

A failure of type error_type that is never retried, whatever the task’s retry policy allows.

Returned by workflow code, it fails the workflow the same way: the workflow is not retried, whatever its retry policy allows. Any other error a workflow returns is retried as its policy says.

Trait Implementations§

Source§

impl Clone for TaskError

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TaskError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for TaskError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for TaskError

1.30.0 · Source§

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

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

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.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
Source§

impl From<TaskError> for Error

Source§

fn from(source: TaskError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more