Skip to main content

AdkError

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 */
}

Expand description

Core traits and types.

Always available regardless of feature flags. Includes:

Agent - The fundamental trait for all agents
Tool / Toolset - For extending agents with capabilities
Session / State - For managing conversation context
Event - For streaming agent responses
AdkError / Result - Unified error handling 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

Available on crate feature tools only.

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

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

Available on crate feature tools only.

Attaches a source error for error chaining.

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

Available on crate feature tools only.

Overrides the default retry hint.

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

Available on crate feature tools only.

Replaces the error details.

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

Available on crate feature tools only.

Sets the upstream HTTP status code in details.

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

Available on crate feature tools only.

Sets the upstream request ID in details.

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

Available on crate feature tools only.

Sets the provider name in details.

impl AdkError

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

Available on crate feature tools only.

Creates a NotFound error for the given component.

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

Available on crate feature tools only.

Creates a RateLimited error for the given component.

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

Available on crate feature tools only.

Creates an Unauthorized error for the given component.

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

Available on crate feature tools only.

Creates an Internal error for the given component.

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

Available on crate feature tools only.

Creates a Timeout error for the given component.

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

Available on crate feature tools only.

Creates an Unavailable error for the given component.

impl AdkError

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

Available on crate feature tools only.

Legacy convenience constructor for agent errors.

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

Available on crate feature tools only.

Legacy convenience constructor for model errors.

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

Available on crate feature tools only.

Legacy convenience constructor for tool errors.

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

Available on crate feature tools only.

Legacy convenience constructor for session errors.

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

Available on crate feature tools only.

Legacy convenience constructor for memory errors.

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

Available on crate feature tools only.

Legacy convenience constructor for configuration errors.

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

Available on crate feature tools only.

Legacy convenience constructor for artifact errors.

impl AdkError

pub fn is_agent(&self) -> bool

Available on crate feature tools only.

Returns true if this error originated in agent logic.

pub fn is_model(&self) -> bool

Available on crate feature tools only.

Returns true if this error originated in model interaction.

pub fn is_tool(&self) -> bool

Available on crate feature tools only.

Returns true if this error originated in tool execution.

pub fn is_session(&self) -> bool

Available on crate feature tools only.

Returns true if this error originated in session management.

pub fn is_artifact(&self) -> bool

Available on crate feature tools only.

Returns true if this error originated in artifact storage.

pub fn is_memory(&self) -> bool

Available on crate feature tools only.

Returns true if this error originated in memory operations.

pub fn is_config(&self) -> bool

Available on crate feature tools only.

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

impl AdkError

pub fn is_retryable(&self) -> bool

Available on crate feature tools only.

Returns true if this error should be retried.

pub fn is_not_found(&self) -> bool

Available on crate feature tools only.

Returns true if this is a not-found error.

pub fn is_unauthorized(&self) -> bool

Available on crate feature tools only.

Returns true if this is an unauthorized error.

pub fn is_rate_limited(&self) -> bool

Available on crate feature tools only.

Returns true if this is a rate-limited error.

pub fn is_timeout(&self) -> bool

Available on crate feature tools only.

Returns true if this is a timeout error.

impl AdkError

pub fn http_status_code(&self) -> u16

Available on crate feature tools only.

Maps the error category to an appropriate HTTP status code.

impl AdkError

pub fn to_problem_json(&self) -> Value

Available on crate feature tools only.

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. Read more

impl Display for AdkError

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

Formats the value using the given formatter. Read more

impl Error for AdkError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more

1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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. Read more

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.

Auto Trait Implementations§

impl !RefUnwindSafe for AdkError

impl !UnwindSafe for AdkError

impl Freeze for AdkError

impl Send for AdkError

impl Sync for AdkError

impl Unpin for AdkError

impl UnsafeUnpin for AdkError

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AsErrorSource for T
where T: Error + 'static,

fn as_error_source(&self) -> &(dyn Error + 'static)

For maximum effectiveness, this needs to be called as a method to benefit from Rust’s automatic dereferencing of method receivers.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> MaybeSend for T
where T: Send,

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToCompactString for T
where T: Display,

fn try_to_compact_string(&self) -> Result<CompactString, ToCompactStringError>

Fallible version of ToCompactString::to_compact_string() Read more

fn to_compact_string(&self) -> CompactString

Converts the given value to a CompactString. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more