Enum Error 

pub enum Error {
    Config(String),
    Session(String),
    SessionNotFound {
        path: String,
    },
    Provider {
        provider: String,
        message: String,
    },
    Auth(String),
    Tool {
        tool: String,
        message: String,
    },
    Validation(String),
    Extension(String),
    Io(Box<Error>),
    Json(Box<Error>),
    Sqlite(Box<Error>),
    Aborted,
    Api(String),
}

Main error type for the Pi application.

Variants

Config(String)

Configuration errors

Session(String)

Session errors

SessionNotFound

Session not found

Fields

path: String

Provider

Provider/API errors

Fields

provider: String

message: String

Auth(String)

Authentication errors

Tool

Tool execution errors

Fields

tool: String

message: String

Validation(String)

Validation errors

Extension(String)

Extension errors

Io(Box<Error>)

IO errors

Json(Box<Error>)

JSON errors

Sqlite(Box<Error>)

SQLite errors

Aborted

User aborted operation

Api(String)

API errors (generic)

Implementations

impl Error

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

Create a configuration error.

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

Create a session error.

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

Create a provider error.

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

Create an authentication error.

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

Create a tool error.

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

Create a validation error.

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

Create an extension error.

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

Create an API error.

pub fn sse(err: &Error) -> Self

Build the user-facing error for an I/O failure that terminated a streaming (SSE) response read.

Retryability is decided here — at the source — from the typed std::io::ErrorKind, because this is the last place the kind is available: the caller immediately flattens the returned error into a message string (AssistantMessage::error_message) that the retry loop consults. For a transient connection drop (reset/abort/EOF/broken pipe/timeout) a canonical transient connection drop marker is appended so the drop is re-driven regardless of the dependency’s (rustls/hyper) prose, which changes phrasing between versions (pi_agent_rust#118).

pub fn is_transient(&self) -> bool

Whether this error is a transient transport failure that is safe to retry, classified from the typed error rather than its flattened message string.

Walks the std::error::Error::source chain (and, for std::io::Error links, the std::io::Error::get_ref chain, which source deliberately skips) looking for an std::io::Error whose std::io::ErrorKind denotes a connection drop. This catches typed I/O failures (e.g. an UnexpectedEof mid-body that propagates as Error::Io) without depending on any substring match. Message-only transient cases (dependency prose with no typed cause) are handled by [is_retryable_error] as a documented fallback.

pub const fn hostcall_error_code(&self) -> &'static str

Map this error to a hostcall taxonomy code.

The hostcall ABI requires every error to be one of: timeout, denied, io, invalid_request, or internal.

pub const fn category_code(&self) -> &'static str

Stable machine-readable error category for automation and diagnostics.

pub fn auth_diagnostic(&self) -> Option<AuthDiagnostic>

Classify auth/config errors into stable machine-readable diagnostics.

pub fn hints(&self) -> ErrorHints

Map internal errors to a stable, user-facing hint taxonomy.

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

fn from(source: Box<Error>) -> Self

Converts to this type from the input type.

impl From<Box<Error>> for Error

fn from(source: Box<Error>) -> Self

Converts to this type from the input type.

impl From<Box<Error>> for Error

fn from(source: Box<Error>) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<LockError> for Error

fn from(value: LockError) -> Self

Converts to this type from the input type.