Enum AgUiError 

#[non_exhaustive]
pub enum AgUiError {
    Protocol(String),
    Cancelled,
    Json(Error),
    ConnectNotImplemented,
    Validation(String),
    Unsupported(String),
    Http {
        status: u16,
        url: Option<String>,
        content_type: Option<String>,
        body: String,
    },
    Transport {
        message: String,
        retryable: bool,
    },
    Other(String),
}

The unified error type for the AG-UI SDK.

The variant set is intentionally #[non_exhaustive] so new categories can be added without a breaking change. Match with a wildcard arm when consuming it outside of this crate.

Use AgUiError::is_retryable to decide whether an operation can be safely retried (e.g. with backoff), and AgUiError::is_user_input to distinguish caller mistakes from transient/transport failures.

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.

Protocol(String)

Cancelled

Json(Error)

ConnectNotImplemented

Validation(String)

Unsupported(String)

Http

A non-success HTTP status returned by an agent endpoint.

status is the raw status code, kept transport-agnostic (the core crate does not depend on any HTTP library). The response body and content_type are preserved for diagnostics.

Fields

status: u16

url: Option<String>

content_type: Option<String>

body: String

Transport

A transport-level failure (connection refused, timeout, DNS, etc.).

retryable is set by the layer that produced the error (which has access to transport details) and is surfaced through AgUiError::is_retryable.

Fields

message: String

retryable: bool

Other(String)

Implementations

impl AgUiError

pub fn protocol(msg: impl Into<String>) -> AgUiError

pub fn cancelled() -> AgUiError

pub fn validation(msg: impl Into<String>) -> AgUiError

pub fn unsupported(msg: impl Into<String>) -> AgUiError

pub fn other(msg: impl Into<String>) -> AgUiError

pub fn http(status: u16, body: impl Into<String>) -> AgUiError

Builds an AgUiError::Http from a status code and response body.

pub fn transport(msg: impl Into<String>, retryable: bool) -> AgUiError

Builds a transport error, explicitly flagging whether a retry is sensible.

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

The HTTP status code, if this error carries one.

pub fn is_retryable(&self) -> bool

Whether retrying the failed operation is likely to help.

Retryable cases:

• transport failures flagged retryable (connect/timeout/request errors)
• HTTP 5xx server errors
• HTTP 429 Too Many Requests (rate limiting / throttling)

pub fn is_user_input(&self) -> bool

Whether the error stems from invalid caller input rather than a transient or transport condition.

Trait Implementations

impl Debug for AgUiError

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

Formats the value using the given formatter.

impl Display for AgUiError

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

Formats the value using the given formatter.

impl Error for AgUiError

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

fn from(source: Error) -> AgUiError

Converts to this type from the input type.