Raxol.AgentClientProtocol.Error (Raxol Agent Client Protocol v0.1.0)

Copy Markdown View Source

JSON-RPC 2.0 error object, plus the ACP-specific vendor error codes.

Standard JSON-RPC 2.0 codes:

  • -32700 — parse error (malformed JSON)
  • -32600 — invalid request (well-formed JSON, not a valid Request object)
  • -32601 — method not found
  • -32602 — invalid params
  • -32603 — internal error

ACP-specific codes:

  • -32000 — authentication required
  • -32002 — resource not found

Decoding is total: from_json/1 never raises. Unknown fields on the wire object are preserved in _meta and re-emitted on encode (forward-compat pass-through), never rejected as an error.

Ported from the MIT f1729/agent_client_protocol (c) 2025 f1729; see NOTICE.md.

Summary

Types

t()

Functions

auth_required()
auth_required_code()
code_name(code)

Convert an ErrorCode integer to its name atom, or {:other, code} when unrecognized.

from_json(map)

Decode a JSON-RPC error object. Total: malformed or wrong-shaped input returns {:error, :invalid_error} rather than raising.

internal_error()
internal_error_code()
invalid_params()
invalid_params_code()
invalid_request()
invalid_request_code()
method_not_found()
method_not_found_code()
new(code, message)
parse_error()
parse_error_code()
resource_not_found(uri \\ nil)
resource_not_found_code()
to_json(err)
with_data(err, data)

Types

t()

@type t() :: %Raxol.AgentClientProtocol.Error{
  _meta: map(),
  code: integer(),
  data: any() | nil,
  message: String.t()
}

Functions

auth_required()

@spec auth_required() :: t()

auth_required_code()

@spec auth_required_code() :: integer()

code_name(code)

@spec code_name(integer()) :: atom() | {:other, integer()}

Convert an ErrorCode integer to its name atom, or {:other, code} when unrecognized.

from_json(map)

@spec from_json(term()) :: {:ok, t()} | {:error, :invalid_error}

Decode a JSON-RPC error object. Total: malformed or wrong-shaped input returns {:error, :invalid_error} rather than raising.

internal_error()

@spec internal_error() :: t()

internal_error_code()

@spec internal_error_code() :: integer()

invalid_params()

@spec invalid_params() :: t()

invalid_params_code()

@spec invalid_params_code() :: integer()

invalid_request()

@spec invalid_request() :: t()

invalid_request_code()

@spec invalid_request_code() :: integer()

method_not_found()

@spec method_not_found() :: t()

method_not_found_code()

@spec method_not_found_code() :: integer()

new(code, message)

@spec new(integer(), String.t()) :: t()

parse_error()

@spec parse_error() :: t()

parse_error_code()

@spec parse_error_code() :: integer()

resource_not_found(uri \\ nil)

@spec resource_not_found(String.t() | nil) :: t()

resource_not_found_code()

@spec resource_not_found_code() :: integer()

to_json(err)

@spec to_json(t()) :: map()

with_data(err, data)

@spec with_data(t(), any()) :: t()