Enum Error 

#[non_exhaustive]
pub enum Error {
    Api {
        message: String,
        status: Option<u16>,
        error_type: Option<String>,
    },
    Auth {
        message: String,
    },
    Network(Error),
    Json(Error),
    Parse(String),
    Tool(ToolError),
    Config(String),
    Io(Error),
    RateLimit {
        retry_after: Option<Duration>,
    },
    ContextOverflow {
        current: usize,
        max: usize,
    },
    Timeout(Duration),
    TokenValidation(TokenValidationError),
    InvalidRequest(String),
    Stream(String),
    Env(VarError),
    NotSupported {
        provider: &'static str,
        operation: &'static str,
    },
    Permission(String),
    BudgetExceeded {
        used: f64,
        limit: f64,
    },
    ModelOverloaded {
        model: String,
    },
    Session(String),
    Mcp(String),
    ResourceExhausted(String),
    HookFailed {
        hook: String,
        reason: String,
    },
    HookTimeout {
        hook: String,
        duration_secs: u64,
    },
}

Error type for claude-agent operations.

All errors include actionable context to help diagnose and resolve issues.

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.

Api

API returned an error response.

Fields

message: String

status: Option<u16>

error_type: Option<String>

Auth

Authentication failed.

Fields

message: String

Network(Error)

Network connectivity or request failed.

Json(Error)

JSON serialization or deserialization failed.

Parse(String)

Failed to parse response or configuration.

Tool(ToolError)

Tool execution failed.

Config(String)

Invalid or missing configuration.

Io(Error)

File system operation failed.

RateLimit

API rate limit exceeded.

Fields

retry_after: Option<Duration>

ContextOverflow

Context window token limit exceeded.

Fields

current: usize

max: usize

Timeout(Duration)

Operation exceeded timeout.

TokenValidation(TokenValidationError)

Token configuration validation failed.

InvalidRequest(String)

Request parameters are invalid.

Stream(String)

Streaming response error.

Env(VarError)

Required environment variable missing or invalid.

NotSupported

Operation not supported by the current provider.

Fields

provider: &'static str

operation: &'static str

Permission(String)

Operation blocked by permission policy.

BudgetExceeded

Budget limit exceeded.

Fields

used: f64

limit: f64

ModelOverloaded

Model is temporarily overloaded.

Fields

model: String

Session(String)

Session operation failed.

Mcp(String)

MCP server communication failed.

ResourceExhausted(String)

System resource limit reached (memory, processes, etc.)

HookFailed

Hook execution failed (blockable hooks only).

Fields

hook: String

reason: String

HookTimeout

Hook timed out (blockable hooks only).

Fields

hook: String

duration_secs: u64

Implementations

impl Error

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

pub fn category(&self) -> ErrorCategory

pub fn is_authorization_error(&self) -> bool

pub fn is_configuration_error(&self) -> bool

pub fn is_resource_limit(&self) -> bool

pub fn is_retryable(&self) -> bool

pub fn is_unauthorized(&self) -> bool

pub fn is_overloaded(&self) -> bool

pub fn status_code(&self) -> Option<u16>

pub fn retry_after(&self) -> Option<Duration>

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<ConfigError> for Error

fn from(err: ConfigError) -> Self

Converts to this type from the input type.

impl From<ContextError> for Error

fn from(err: ContextError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<McpError> for Error

fn from(err: McpError) -> Self

Converts to this type from the input type.

impl From<SandboxError> for Error

fn from(err: SandboxError) -> Self

Converts to this type from the input type.

impl From<SecurityError> for Error

fn from(err: SecurityError) -> Self

Converts to this type from the input type.

impl From<SessionError> for Error

fn from(err: SessionError) -> Self

Converts to this type from the input type.

impl From<TokenValidationError> for Error

fn from(source: TokenValidationError) -> Self

Converts to this type from the input type.

impl From<ToolError> for Error

fn from(source: ToolError) -> Self

Converts to this type from the input type.

impl From<VarError> for Error

fn from(source: VarError) -> Self

Converts to this type from the input type.