Enum WorkflowError 

#[non_exhaustive]
pub enum WorkflowError {
    CommandRejected {
        reason: String,
    },
    InvalidState {
        expected: String,
        actual: String,
    },
    ValidationFailed {
        message: String,
    },
    NotImplemented {
        pid: u32,
    },
    Other {
        message: String,
    },
}

Reasons a workflow may refuse a command.

Variants (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.

CommandRejected

The command is not valid for the process in its current state.

Fields

reason: String

Human-readable rejection reason.

InvalidState

The command arrived when the process was in an unexpected state.

Fields

expected: String

The state the workflow expected.

actual: String

The actual state the process was in.

ValidationFailed

Domain validation of the command payload failed.

Fields

message: String

Description of what failed validation.

NotImplemented

The process identified by pid is registered in the PID router but has no workflow implementation yet.

Callers should respond to the sender with a CONTRL/APERAK rejection. This variant is never a transient error — it indicates missing implementation and must not be retried.

Fields

pid: u32

The Prüfidentifikator that has no implementation.

Other

An unexpected error occurred inside the workflow handler.

Fields

message: String

Error description.

Implementations

impl WorkflowError

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

Construct a WorkflowError::CommandRejected with a formatted reason.

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

Construct a WorkflowError::InvalidState.

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

Construct a WorkflowError::ValidationFailed.

pub fn not_implemented(pid: u32) -> Self

Construct a WorkflowError::NotImplemented for a given PID.

Use this to signal that the PID is routed but has no workflow implementation. Callers must respond with a CONTRL/APERAK rejection to the sender — this variant must never be silently discarded.

pub fn other(message: impl Into<String>) -> Self

Construct a WorkflowError::Other.

pub fn is_rejected(&self) -> bool

Return true when this is a WorkflowError::CommandRejected.

pub fn is_invalid_state(&self) -> bool

Return true when this is a WorkflowError::InvalidState.

pub fn is_validation_failed(&self) -> bool

Return true when this is a WorkflowError::ValidationFailed.

pub fn is_not_implemented(&self) -> bool

Return true when this is a WorkflowError::NotImplemented.

This variant is never transient — callers must not retry.

Trait Implementations

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, __formatter: &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.

impl From<WorkflowError> for EngineError

fn from(source: WorkflowError) -> Self

Converts to this type from the input type.