Skip to main content

WorkflowError

Enum WorkflowError 

Source
#[non_exhaustive]
pub enum WorkflowError {
Show 17 variants
#[non_exhaustive]
TaskFailed { task_type: String, attempts: u32, reason: String, error_type: String, code: TaskFailureCode, },
#[non_exhaustive]
TimerFailed { timer_id: String, reason: String, },
#[non_exhaustive]
ChildWorkflowFailed { workflow_type: String, workflow_id: String, reason: String, }, StateError(String), Canceled,
#[non_exhaustive]
Timeout { timeout: Duration, }, Panic(String), NonDeterministic(String),
#[non_exhaustive]
EventError { event: String, reason: String, },
#[non_exhaustive]
QueryError { query: String, reason: String, },
#[non_exhaustive]
CompensationFailed { failed: Vec<String>, reason: String, step_failure: Option<String>, }, InvalidState(String),
#[non_exhaustive]
NotFound { workflow_id: String, }, ReplayError(String), RestartFreshError(String),
#[non_exhaustive]
VersionMismatch { expected: String, actual: String, },
#[non_exhaustive]
Suspended { reason: String, pending_operations: Vec<String>, },
}
Expand description

Errors that can occur during workflow 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.
§

#[non_exhaustive]
TaskFailed

A task executed by the workflow failed

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_type: String

The type/name of the task that failed

§attempts: u32

Number of retry attempts made

§reason: String

The reason for the failure

§error_type: String

The failure’s type, as a retry policy’s non-retryable list names it: the error_type of a TaskError::application failure, for example. Empty for a failure of no particular type.

§code: TaskFailureCode

The failure’s category: whether the task’s code raised it, it was cancelled, or it timed out.

§

#[non_exhaustive]
TimerFailed

A timer operation failed

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.
§timer_id: String

The ID of the timer that failed

§reason: String

The reason for the failure

§

#[non_exhaustive]
ChildWorkflowFailed

A child workflow failed

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.
§workflow_type: String

The type of the child workflow

§workflow_id: String

The ID of the child workflow instance

§reason: String

The reason for the failure

§

StateError(String)

Workflow state management error

Tuple Fields

§0: String

Description of the state error

§

Canceled

Workflow was canceled

§

#[non_exhaustive]
Timeout

Workflow 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

§

Panic(String)

Workflow panicked

Tuple Fields

§0: String

The panic message

§

NonDeterministic(String)

Workflow execution is not deterministic

Tuple Fields

§0: String

Description of the non-determinism violation

§

#[non_exhaustive]
EventError

Event handling error

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.
§event: String

The name of the event that failed

§reason: String

The reason for the failure

§

#[non_exhaustive]
QueryError

Query handling error

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.
§query: String

The name of the query that failed

§reason: String

The reason for the failure

§

#[non_exhaustive]
CompensationFailed

A saga’s compensations ran, and at least one of them failed.

Every compensation still runs when one fails; this reports the ones that failed once all have run. Returned by Saga::compensate, and by a failed saga step whose compensating failed, which then carries the step’s own failure in step_failure.

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.
§failed: Vec<String>

The compensation tasks that failed, in the order they ran.

§reason: String

The first failed compensation’s error.

§step_failure: Option<String>

The failure of the saga step that started the compensating, or None when the workflow compensated the saga itself.

§

InvalidState(String)

Invalid workflow state

Tuple Fields

§0: String

Description of the invalid state

§

#[non_exhaustive]
NotFound

Workflow 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.
§workflow_id: String

The ID of the workflow that was not found

§

ReplayError(String)

Replay error

Tuple Fields

§0: String

Description of the replay error

§

RestartFreshError(String)

Restarting the workflow fresh failed.

Tuple Fields

§0: String

Description of the restart error

§

#[non_exhaustive]
VersionMismatch

Version mismatch error

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.
§expected: String

The expected version

§actual: String

The actual version found

§

#[non_exhaustive]
Suspended

The workflow is waiting for operations it started to complete.

This is control flow, not a failure. A workflow returns it when it calls ctx.execute() and the result is not available yet. The workflow executor catches it, sends the pending commands to the server, and replays the workflow once results arrive. See Error::is_suspend.

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.
§reason: String

Human-readable reason for suspension

§pending_operations: Vec<String>

List of pending operation IDs (task IDs, timer IDs, etc.)

Implementations§

Source§

impl WorkflowError

Source

pub fn task_failed( task_type: impl Into<String>, attempts: u32, reason: impl Into<String>, ) -> Self

Create a task failed error

Source

pub fn with_failure_type( self, error_type: impl Into<String>, code: TaskFailureCode, ) -> Self

Sets a TaskFailed error’s type and category; any other error is returned as it is.

Source

pub fn task_failure_code(&self) -> Option<TaskFailureCode>

The category of a TaskFailed error, or None for any other error.

Source

pub fn task_failure_type(&self) -> Option<&str>

The type of a TaskFailed error, or None for any other error. Empty for a failure of no particular type.

Source

pub fn is_task_cancelled(&self) -> bool

Whether this is a TaskFailed error for a task that was cancelled: its category is TaskFailureCode::Cancelled, or its type is Cancelled, which is how an engine that does not categorize failures records a cancellation.

Source

pub fn timer_failed( timer_id: impl Into<String>, reason: impl Into<String>, ) -> Self

Create a timer failed error

Source

pub fn child_workflow_failed( workflow_type: impl Into<String>, workflow_id: impl Into<String>, reason: impl Into<String>, ) -> Self

Create a child workflow failed error

Source

pub fn event_error(event: impl Into<String>, reason: impl Into<String>) -> Self

Create an event error

Source

pub fn query_error(query: impl Into<String>, reason: impl Into<String>) -> Self

Create a query error

Source

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

Create a not found error

Source

pub fn timeout(timeout: Duration) -> Self

Create a timeout error

Source

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

Create a non-deterministic error

Source

pub fn version_mismatch( expected: impl Into<String>, actual: impl Into<String>, ) -> Self

Create a version mismatch error

Source

pub fn suspended( reason: impl Into<String>, pending_operations: Vec<String>, ) -> Self

Create the suspension signal: the workflow waits on these operations

Trait Implementations§

Source§

impl Clone for WorkflowError

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 WorkflowError

Source§

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

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

impl Display for WorkflowError

Source§

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

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

impl Error for WorkflowError

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<WorkflowError> for Error

Source§

fn from(source: WorkflowError) -> 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