Enum AgentError 

#[non_exhaustive]
pub enum AgentError {
    Model(ModelError),
    Tool(ToolError),
    Retrieval(RetrievalError),
    Budget(BudgetExceeded),
    Gateway(GatewayError),
    Journal(JournalError),
    Checkpoint(CheckpointError),
    Effect(EffectExecutorError),
    AmbiguousCheckpoint {
        turn: u32,
    },
    InvalidConfig(String),
    Protocol(String),
    MaxTurns {
        max_turns: u32,
    },
    ToolRequirementUnsatisfied {
        required: u32,
        successful: u32,
    },
    ToolRequirementExceedsBudget {
        required: u32,
        remaining: u64,
    },
    EmptyTerminalResponse {
        attempts: u32,
    },
    StructuredOutputUnsatisfied {
        attempts: u32,
        kind: StructuredOutputErrorKind,
        line: Option<usize>,
        column: Option<usize>,
    },
    ToolOutputNotVisible {
        tool: String,
    },
}

Failure of an agent run.

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.

Model(ModelError)

Model invocation failed.

Tool(ToolError)

Tool execution failed.

Retrieval(RetrievalError)

Static or dynamic context retrieval failed.

Budget(BudgetExceeded)

A shared run-tree budget was exceeded.

Gateway(GatewayError)

Agent delegation failed.

Journal(JournalError)

Structured event recording failed.

Checkpoint(CheckpointError)

Checkpoint persistence or validation failed.

Effect(EffectExecutorError)

Write-ahead effect coordination failed.

AmbiguousCheckpoint

Recovery would silently retry a possibly partial external turn.

Fields

turn: u32

One-based interrupted turn number.

InvalidConfig(String)

Agent configuration is invalid.

Protocol(String)

Model output violated the agent-loop protocol.

MaxTurns

The configured local turn bound was reached.

Fields

max_turns: u32

Configured local turn bound.

ToolRequirementUnsatisfied

The model terminated before the successful local Tool-call minimum.

Fields

required: u32

Required successful local Tool calls.

successful: u32

Successful local Tool calls observed in this execution.

ToolRequirementExceedsBudget

The remaining shared Tool-call budget cannot satisfy the local minimum.

Fields

required: u32

Additional successful local Tool calls still required.

remaining: u64

Remaining shared Tool-call budget.

EmptyTerminalResponse

The provider exhausted bounded repairs without producing usable content.

Fields

attempts: u32

Repair turns completed before failing.

StructuredOutputUnsatisfied

The provider exhausted bounded repairs without satisfying the Rust type.

Fields

attempts: u32

Repair turns completed before failing.

kind: StructuredOutputErrorKind

Stable local structured-output failure category.

line: Option<usize>

One-based JSON line, when available.

column: Option<usize>

One-based JSON column, when available.

ToolOutputNotVisible

A tool produced output that policy forbids exposing to the model.

Fields

tool: String

Tool name.

Implementations

impl AgentError

pub fn run_error_kind(&self) -> RunErrorKind

Returns the stable run-level failure category for business policy.

pub fn retry_safety(&self) -> RetrySafety

Returns whether retrying this failed Agent run is known to be safe.

pub fn to_run_error(&self) -> RunError

Normalizes this failure into the public run-level policy contract.

Trait Implementations

impl Debug for AgentError

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

Formats the value using the given formatter.

impl Display for AgentError

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

Formats the value using the given formatter.

impl Error for AgentError

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<AgentError> for AgentPromptError

fn from(source: AgentError) -> Self

Converts to this type from the input type.

impl From<AgentError> for StructuredAgentError

fn from(source: AgentError) -> Self

Converts to this type from the input type.

impl From<BudgetExceeded> for AgentError

fn from(source: BudgetExceeded) -> Self

Converts to this type from the input type.

impl From<CheckpointError> for AgentError

fn from(source: CheckpointError) -> Self

Converts to this type from the input type.

impl From<EffectExecutorError> for AgentError

fn from(source: EffectExecutorError) -> Self

Converts to this type from the input type.

impl From<GatewayError> for AgentError

fn from(source: GatewayError) -> Self

Converts to this type from the input type.

impl From<JournalError> for AgentError

fn from(source: JournalError) -> Self

Converts to this type from the input type.

impl From<ModelError> for AgentError

fn from(source: ModelError) -> Self

Converts to this type from the input type.

impl From<RetrievalError> for AgentError

fn from(source: RetrievalError) -> Self

Converts to this type from the input type.

impl From<ToolError> for AgentError

fn from(source: ToolError) -> Self

Converts to this type from the input type.