Struct AdkError 

pub struct AdkError {
    pub component: ErrorComponent,
    pub category: ErrorCategory,
    pub code: &'static str,
    pub message: String,
    pub retry: RetryHint,
    pub details: Box<ErrorDetails>,
    /* private fields */
}

Available on crate feature tools only.

Unified structured error type for all ADK-Rust operations.

Migration from enum syntax

Before (0.4.x enum):

// Construction
Err(AdkError::Model("rate limited".into()))
// Matching
matches!(err, AdkError::Model(_))

After (0.5.x struct):

use adk_core::{AdkError, ErrorComponent, ErrorCategory};

// Structured construction
let err = AdkError::new(
    ErrorComponent::Model,
    ErrorCategory::RateLimited,
    "model.openai.rate_limited",
    "rate limited",
);
assert!(err.is_retryable()); // RateLimited → should_retry = true

// Backward-compat construction (for migration)
let err = AdkError::model("rate limited");
assert!(err.is_model());

Fields

component: ErrorComponent

The subsystem that produced the error.

category: ErrorCategory

The kind of failure.

code: &'static str

Machine-readable error code (e.g., “model.openai.rate_limited”).

message: String

Human-readable error message.

retry: RetryHint

Retry guidance for this error.

details: Box<ErrorDetails>

Additional structured metadata.

Implementations

impl AdkError

pub fn new( component: ErrorComponent, category: ErrorCategory, code: &'static str, message: impl Into<String>, ) -> AdkError

Creates a new AdkError with the given component, category, code, and message.

pub fn with_source(self, source: impl Error + Send + Sync + 'static) -> AdkError

Attaches a source error for error chaining.

pub fn with_retry(self, retry: RetryHint) -> AdkError

Overrides the default retry hint.

pub fn with_details(self, details: ErrorDetails) -> AdkError

Replaces the error details.

pub fn with_upstream_status(self, status_code: u16) -> AdkError

Sets the upstream HTTP status code in details.

pub fn with_request_id(self, request_id: impl Into<String>) -> AdkError

Sets the upstream request ID in details.

pub fn with_provider(self, provider: impl Into<String>) -> AdkError

Sets the provider name in details.

impl AdkError

pub fn not_found( component: ErrorComponent, code: &'static str, message: impl Into<String>, ) -> AdkError

Creates a NotFound error for the given component.

pub fn rate_limited( component: ErrorComponent, code: &'static str, message: impl Into<String>, ) -> AdkError

Creates a RateLimited error for the given component.

pub fn unauthorized( component: ErrorComponent, code: &'static str, message: impl Into<String>, ) -> AdkError

Creates an Unauthorized error for the given component.

pub fn internal( component: ErrorComponent, code: &'static str, message: impl Into<String>, ) -> AdkError

Creates an Internal error for the given component.

pub fn timeout( component: ErrorComponent, code: &'static str, message: impl Into<String>, ) -> AdkError

Creates a Timeout error for the given component.

pub fn unavailable( component: ErrorComponent, code: &'static str, message: impl Into<String>, ) -> AdkError

Creates an Unavailable error for the given component.

impl AdkError

pub fn agent(message: impl Into<String>) -> AdkError

Legacy convenience constructor for agent errors.

pub fn model(message: impl Into<String>) -> AdkError

Legacy convenience constructor for model errors.

pub fn tool(message: impl Into<String>) -> AdkError

Legacy convenience constructor for tool errors.

pub fn session(message: impl Into<String>) -> AdkError

Legacy convenience constructor for session errors.

pub fn memory(message: impl Into<String>) -> AdkError

Legacy convenience constructor for memory errors.

pub fn config(message: impl Into<String>) -> AdkError

Legacy convenience constructor for configuration errors.

pub fn artifact(message: impl Into<String>) -> AdkError

Legacy convenience constructor for artifact errors.

impl AdkError

pub fn is_agent(&self) -> bool

Returns true if this error originated in agent logic.

pub fn is_model(&self) -> bool

Returns true if this error originated in model interaction.

pub fn is_tool(&self) -> bool

Returns true if this error originated in tool execution.

pub fn is_session(&self) -> bool

Returns true if this error originated in session management.

pub fn is_artifact(&self) -> bool

Returns true if this error originated in artifact storage.

pub fn is_memory(&self) -> bool

Returns true if this error originated in memory operations.

pub fn is_config(&self) -> bool

Returns true if this is a configuration error (legacy code path).

impl AdkError

pub fn is_retryable(&self) -> bool

Returns true if this error should be retried.

pub fn is_not_found(&self) -> bool

Returns true if this is a not-found error.

pub fn is_unauthorized(&self) -> bool

Returns true if this is an unauthorized error.

pub fn is_rate_limited(&self) -> bool

Returns true if this is a rate-limited error.

pub fn is_timeout(&self) -> bool

Returns true if this is a timeout error.

impl AdkError

pub fn http_status_code(&self) -> u16

Maps the error category to an appropriate HTTP status code.

impl AdkError

pub fn to_problem_json(&self) -> Value

Serializes the error as a JSON Problem Details object.

Trait Implementations

impl Debug for AdkError

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

Formats the value using the given formatter.

impl Display for AdkError

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

Formats the value using the given formatter.

impl Error for AdkError

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<AdkError> for EvalError

fn from(err: AdkError) -> EvalError

Converts to this type from the input type.

impl From<AdkError> for RagError

fn from(source: AdkError) -> RagError

Converts to this type from the input type.

impl From<AnthropicApiError> for AdkError

fn from(err: AnthropicApiError) -> AdkError

Converts to this type from the input type.

impl From<AuthError> for AdkError

fn from(err: AuthError) -> AdkError

Converts to this type from the input type.

impl From<CodeError> for AdkError

fn from(err: CodeError) -> AdkError

Converts to this type from the input type.

impl From<ComputerUseError> for AdkError

fn from(error: ComputerUseError) -> AdkError

Converts to this type from the input type.

impl From<ConversionError> for AdkError

fn from(err: ConversionError) -> AdkError

Converts to this type from the input type.

impl From<EvalError> for AdkError

fn from(err: EvalError) -> AdkError

Converts to this type from the input type.

impl From<ExecutionError> for AdkError

fn from(err: ExecutionError) -> AdkError

Converts to this type from the input type.

impl From<GraphError> for AdkError

fn from(err: GraphError) -> AdkError

Converts to this type from the input type.

impl From<GuardrailError> for AdkError

fn from(err: GuardrailError) -> AdkError

Converts to this type from the input type.

impl From<IdentityError> for AdkError

fn from(err: IdentityError) -> AdkError

Converts to this type from the input type.

impl From<PaymentsAuthError> for AdkError

fn from(value: PaymentsAuthError) -> AdkError

Converts to this type from the input type.

impl From<PaymentsKernelError> for AdkError

fn from(value: PaymentsKernelError) -> AdkError

Converts to this type from the input type.

impl From<RagError> for AdkError

fn from(err: RagError) -> AdkError

Converts to this type from the input type.

impl From<SandboxError> for AdkError

fn from(err: SandboxError) -> AdkError

Converts to this type from the input type.

impl From<SharedStateError> for AdkError

fn from(err: SharedStateError) -> AdkError

Converts to this type from the input type.

impl From<SkillError> for AdkError

fn from(err: SkillError) -> AdkError

Converts to this type from the input type.

impl From<TeamError> for AdkError

fn from(error: TeamError) -> AdkError

Converts to this type from the input type.

impl From<TeamRuntimeError> for AdkError

fn from(error: TeamRuntimeError) -> AdkError

Converts to this type from the input type.