Enum StepOutcome 

#[non_exhaustive]
pub enum StepOutcome {
    Continue {
        payload: Vec<u8>,
    },
    ContinueAfter {
        payload: Vec<u8>,
        delay: Duration,
    },
    Succeed {
        result: Vec<u8>,
    },
    Fail {
        reason: String,
    },
    Cancel {
        reason: String,
    },
}

What the runner wants the runtime to do after this step.

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.

Continue

Run is not finished. Enqueue the next step immediately with payload as its bytes. The runtime advances step_number by 1.

Fields

payload: Vec<u8>

Bytes to hand to the next step’s Step::payload.

ContinueAfter

Like Self::Continue but the next step is scheduled delay from now (e.g. backing off after a 429 from a provider).

Fields

payload: Vec<u8>

Bytes to hand to the next step’s Step::payload.

delay: Duration

How long to wait before the next step becomes claimable.

Succeed

The run is finished successfully. The runtime acks the step and fires the configured terminal hook with crate::TerminalStatus::Succeeded and result as the body.

Fields

result: Vec<u8>

Final result bytes handed to the terminal hook.

Fail

The run is finished as failed by the runner’s verdict; the runner ran to completion but the workflow’s logical outcome is “no” (e.g. a validation rule rejected the input, a policy check denied the request, an agent decided the task can’t be fulfilled). The runtime acks the step and fires the terminal hook with crate::TerminalStatus::Failed and reason as the error.

Use this for workflow-level failures. For infrastructure failures (network outage, downstream service down, etc.) return Err(StepError::transient) or Err(StepError::permanent) instead; those dead-letter the step so an operator can find it via taquba::Queue::dead_jobs. Fail is a successful execution with a negative outcome and does not dead-letter.

Fields

reason: String

Human-readable reason recorded on crate::RunOutcome::error.

Cancel

The run is finished as cancelled by the runner. Use this when the runner decides on its own that the workflow should stop early without it being a logical failure (e.g. a downstream cancellation signal arrived mid-step, the user-supplied input is now obsolete). The runtime acks the step and fires the terminal hook with crate::TerminalStatus::Cancelled and reason as the error.

For external cancellation requested by another component in the process, call crate::WorkflowRuntime::cancel instead; the runtime translates that into the same Cancelled terminal state.

Fields

reason: String

Human-readable reason recorded on crate::RunOutcome::error.

Trait Implementations

impl Clone for StepOutcome

fn clone(&self) -> StepOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StepOutcome

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

Formats the value using the given formatter.