JSONRPC2.Spec.Error (jsonrpc2_spec v0.2.0)

Copy Markdown

Struct which represents JSONRPC error.

Summary

Types

code()
data()
error()
message()
raw_code()
t()

Functions

code2error(code)
new(id, code)

Create error struct with predefined errors.

new(id, code, message_or_data)

Create error struct.

new(id, code, message, data)

Create error struct with custom errors.

Types

code()

@type code() :: integer()

data()

@type data() :: String.t() | map() | keyword()

error()

@type error() :: %{:code => code(), :message => message(), optional(:data) => data()}

message()

@type message() :: String.t()

raw_code()

@type raw_code() :: integer() | atom()

t()

@type t() :: %JSONRPC2.Spec.Error{
  error: error(),
  id: JSONRPC2.Spec.id(),
  jsonrpc: String.t()
}

Functions

code2error(code)

@spec code2error(atom()) :: {code(), message()}

new(id, code)

@spec new(JSONRPC2.Spec.id(), atom()) :: t()

Create error struct with predefined errors.

Example:

iex> Error.new("123", :invalid_request)
%Error{id: "123", error: %{code: -32600, message: "Invalid request"}, jsonrpc: "2.0"}

new(id, code, message_or_data)

@spec new(JSONRPC2.Spec.id(), raw_code(), message() | data()) :: t()

Create error struct.

Example:

iex> Error.new("123", :invalid_params, %{"x" => ["is not a integer"]})
%Error{id: "123", error: %{code: -32602, message: "Invalid params", data: %{"x" => ["is not a integer"]}}, jsonrpc: "2.0"}

iex> Error.new("123", 500, "Some valuable error")
%Error{id: "123", error: %{code: 500, message: "Some valuable error"}, jsonrpc: "2.0"}

new(id, code, message, data)

@spec new(JSONRPC2.Spec.id(), raw_code(), message(), data()) :: t()

Create error struct with custom errors.

Example:

iex> Error.new("123", 500, "Some valuable error", "details")
%Error{id: "123", error: %{code: 500, message: "Some valuable error", data: "details"}, jsonrpc: "2.0"}