Struct WorkflowError 

pub struct WorkflowError { /* private fields */ }

Runtime error for the Serverless Workflow engine

Implementations

impl WorkflowError

pub fn kind(&self) -> ErrorKind

Returns the error kind

pub fn fields(&self) -> &ErrorFields

Returns a reference to the error fields

pub fn validation(message: impl Into<String>, task: impl Into<String>) -> Self

Creates a validation error

pub fn expression(message: impl Into<String>, task: impl Into<String>) -> Self

Creates an expression error

pub fn runtime( message: impl Into<String>, task: impl Into<String>, instance: impl Into<String>, ) -> Self

Creates a runtime error

pub fn runtime_simple( message: impl Into<String>, task: impl Into<String>, ) -> Self

Creates a runtime error without an instance (defaults to empty string)

pub fn timeout(message: impl Into<String>, task: impl Into<String>) -> Self

Creates a timeout error Per the Serverless Workflow spec, timeout errors have status 408

pub fn communication( message: impl Into<String>, task: impl Into<String>, ) -> Self

Creates a communication error

pub fn communication_with_status( message: impl Into<String>, task: impl Into<String>, status_code: u16, ) -> Self

Creates a communication error with an HTTP status code

pub fn typed( error_type: &str, detail: String, task: String, instance: String, status: Option<Value>, title: Option<String>, ) -> Self

Creates a typed error from DSL error definition fields

pub fn error_type(&self) -> &str

Returns the error type as a full URI (prefers original type from DSL if available)

pub fn error_type_short(&self) -> &str

Returns the short error type name (last segment of URI)

pub fn task(&self) -> &str

Returns the task name associated with this error

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

Returns the instance reference, if available

pub fn status(&self) -> Option<&Value>

Returns the status code, if available

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

Returns the title, if available

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

Returns the detail, if available

pub fn to_value(&self) -> Value

Converts the error to a JSON Value for use in expressions (e.g., $caughtError)

pub fn with_instance(self, instance: impl Into<String>) -> Self

Sets the instance reference on the error if not already set

Trait Implementations

impl Clone for WorkflowError

fn clone(&self) -> WorkflowError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowError

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

Formats the value using the given formatter.

impl Display for WorkflowError

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

Formats the value using the given formatter.

impl Error for WorkflowError

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.