Enum WorkflowTermination 

pub enum WorkflowTermination {
    Cancelled {
        details: Option<Box<dyn WorkflowOutputValue + Send + Sync>>,
    },
    Evicted,
    ContinueAsNew(Box<ContinueAsNewWorkflowExecution>),
    Failed(OutgoingWorkflowError),
}

Represents ways a workflow can terminate without producing a normal result.

Payload conversion errors returned by workflow operations propagated directly into WorkflowTermination, such as with ?, will fail the current Workflow Task so it can be retried.

Wrap an error in an ApplicationFailure to explicitly fail the Workflow Execution.

Variants

Cancelled

The Workflow Execution was cancelled, optionally with user-supplied details.

Fields

details: Option<Box<dyn WorkflowOutputValue + Send + Sync>>

Optional cancellation details.

Evicted

The workflow was evicted and must stop without producing a completion command.

ContinueAsNew(Box<ContinueAsNewWorkflowExecution>)

The workflow requested a new run with the supplied command attributes.

Failed(OutgoingWorkflowError)

The Workflow Execution failed with an error already converted for outbound handling.

Implementations

impl WorkflowTermination

pub fn cancelled() -> Self

Construct a cancelled workflow termination without details.

pub fn cancelled_with_details<T>(details: T) -> Self

where T: TemporalSerializable + Send + Sync + 'static,

Construct a cancelled workflow termination with details that will be converted using the active payload converter.

pub fn continue_as_new(can: ContinueAsNewWorkflowExecution) -> Self

Constructs a termination that asks the worker to continue the workflow as a new run.

pub fn failed_application(err: ApplicationFailure) -> Self

Construct a WorkflowTermination::Failed from an ApplicationFailure.

Trait Implementations

impl Debug for WorkflowTermination

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

Formats the value using the given formatter.

impl Display for WorkflowTermination

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

Formats the value using the given formatter.

impl Error for WorkflowTermination

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<ActivityExecutionError> for WorkflowTermination

fn from(value: ActivityExecutionError) -> Self

Converts to this type from the input type.

impl From<ApplicationFailure> for WorkflowTermination

fn from(value: ApplicationFailure) -> Self

Converts to this type from the input type.

impl From<CancelExternalWorkflowError> for WorkflowTermination

fn from(value: CancelExternalWorkflowError) -> Self

Converts to this type from the input type.

impl From<ChildWorkflowExecutionError> for WorkflowTermination

fn from(value: ChildWorkflowExecutionError) -> Self

Converts to this type from the input type.

impl From<ChildWorkflowStartError> for WorkflowTermination

fn from(value: ChildWorkflowStartError) -> Self

Converts to this type from the input type.

impl From<PayloadConversionError> for WorkflowTermination

fn from(value: PayloadConversionError) -> Self

Converts to this type from the input type.

impl From<WorkflowCancellationError> for WorkflowTermination

fn from(_value: WorkflowCancellationError) -> Self

Converts to this type from the input type.

impl From<WorkflowSignalError> for WorkflowTermination

fn from(value: WorkflowSignalError) -> Self

Converts to this type from the input type.