Struct Error 

#[non_exhaustive]
pub struct Error {
    pub code: ErrorCode,
    pub message: String,
    pub data: Option<Value>,
    /* private fields */
}

A JSON-RPC error object, independent of the ACP protocol version.

This is the error type of every SDK callback and connection method. An error returned from a request handler is sent to the peer as an Error Response with exactly this code, message and data.

Build errors with the shared constructors below, or with a schema version’s constructors followed by .into() when the error data differs between versions:

Code	Constructor
-32700	Error::parse_error
-32600	Error::invalid_request
-32601	Error::method_not_found
-32602	Error::invalid_params
-32603	Error::internal_error, Error::into_internal_error
-32800	Error::request_cancelled
-32000	Error::auth_required
-32002	v1::schema::Error::resource_not_found(uri), v1::schema::Error::session_not_found(id), v2::schema::Error::resource_not_found(), v2::schema::Error::session_not_found(id)
-32022	v2::schema::Error::unsupported_protocol_version(requested, supported)

Convert back with v1::schema::Error::from(error) or v2::schema::Error::from(error) to use a schema version’s view of the error. Typed v2 error data is read with serde_json:

use agent_client_protocol::{Error, v2::schema};

let error: Error = schema::Error::session_not_found("sess_1").into();
if error.code == schema::ErrorCode::ResourceNotFound
    && let Some(data) = error.data.clone()
    && let Ok(data) = serde_json::from_value::<schema::SessionNotFoundErrorData>(data)
{
    assert_eq!(data.session_id.0.as_ref(), "sess_1");
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: ErrorCode

The JSON-RPC error code.

message: String

A short description of the error.

data: Option<Value>

Optional additional information about the error.

Some(Value::Null) is sent as an explicit "data": null; None omits the field.

Implementations

impl Error

pub fn new(code: impl Into<ErrorCode>, message: impl Into<String>) -> Self

Creates an error with the given code and message and no data.

pub fn data(self, data: impl IntoOption<Value>) -> Self

Sets the error’s data, replacing any existing data.

pub fn parse_error() -> Self

-32700: invalid JSON was received.

pub fn invalid_request() -> Self

-32600: the JSON sent is not a valid request object.

pub fn method_not_found() -> Self

-32601: the method does not exist or is not available.

pub fn invalid_params() -> Self

-32602: invalid method parameters.

pub fn internal_error() -> Self

-32603: internal JSON-RPC error.

pub fn request_cancelled() -> Self

-32800: the request was cancelled, either by the caller or because of resource constraints or shutdown.

pub fn auth_required() -> Self

-32000: authentication is required before this operation.

pub fn into_internal_error(err: impl Error) -> Self

Converts any error into an internal error (-32603) whose data is the error’s string representation.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Error

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

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

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Recovers an SDK or schema error wrapped in the anyhow::Error, and converts anything else into an internal error.

impl From<Error> for Error

fn from(error: Error) -> Self

An invalid params error (-32602) whose data is the serde message.

impl From<ErrorCode> for Error

fn from(code: ErrorCode) -> Self

An error with the code’s default message and no data.

impl From<UnknownToolError> for Error

Available on crate feature schemars only.

fn from(error: UnknownToolError) -> Self

Converts to this type from the input type.

impl JsonSchema for Error

Available on crate feature schemars only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Error

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Error

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.