Enum HandlerOutput 

pub enum HandlerOutput {
    Success {
        output: Option<Vec<u8>>,
        consumption: Vec<BudgetConsumption>,
    },
    RetryableFailure {
        error: String,
        consumption: Vec<BudgetConsumption>,
    },
    TerminalFailure {
        error: String,
        consumption: Vec<BudgetConsumption>,
    },
    Suspended {
        output: Option<Vec<u8>>,
        consumption: Vec<BudgetConsumption>,
    },
}

Outcome of an attempt execution.

The handler return type uses typed variants to distinguish between successful completion, retryable failures (transient errors that may succeed on retry), and terminal failures (permanent errors that should not be retried). Handlers may also return Suspended to signal that execution was voluntarily preempted (e.g. in response to budget exhaustion).

All variants carry a consumption list: zero or more BudgetConsumption records reporting the resources consumed during this attempt. The dispatch loop durably records these after each attempt completes.

Variants

Success

Execution completed successfully.

Fields

output: Option<Vec<u8>>

Optional output data produced by the execution.

consumption: Vec<BudgetConsumption>

Resource consumption incurred during this attempt.

RetryableFailure

Execution failed but may succeed on retry (transient failure).

Fields

error: String

Error message describing the failure cause.

consumption: Vec<BudgetConsumption>

Resource consumption incurred before the failure.

TerminalFailure

Execution failed permanently and should not be retried.

Fields

error: String

Error message describing the failure cause.

consumption: Vec<BudgetConsumption>

Resource consumption incurred before the failure.

Suspended

Execution was voluntarily suspended (e.g. budget exhaustion signalled via the cancellation token). The run transitions to Suspended and does not count this attempt toward the max_attempts retry cap.

Fields

output: Option<Vec<u8>>

Optional partial-state bytes the handler may persist for use on resume.

consumption: Vec<BudgetConsumption>

Resource consumption incurred before suspension.

Implementations

impl HandlerOutput

pub fn success() -> Self

Creates a success output with no output bytes and no consumption.

pub fn success_with_output(output: Vec<u8>) -> Self

Creates a success output with output bytes and no consumption.

pub fn retryable_failure(error: impl Into<String>) -> Self

Creates a retryable failure with no consumption.

pub fn terminal_failure(error: impl Into<String>) -> Self

Creates a terminal failure with no consumption.

pub fn suspended() -> Self

Creates a suspended outcome with no partial state and no consumption.

pub fn suspended_with_output( output: Vec<u8>, consumption: Vec<BudgetConsumption>, ) -> Self

Creates a suspended outcome with partial-state bytes and consumption.

pub fn consumption(&self) -> &[BudgetConsumption]

Returns the resource consumption reported by this handler output.

Trait Implementations

impl Clone for HandlerOutput

fn clone(&self) -> HandlerOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HandlerOutput

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

Formats the value using the given formatter.

impl PartialEq for HandlerOutput

fn eq(&self, other: &HandlerOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for HandlerOutput

impl StructuralPartialEq for HandlerOutput