EasyRpc.Error exception (EasyRpc v0.6.0)

Unified error handling for EasyRpc library.

This module provides structured error handling with different error types and helper functions for error creation, logging, and formatting.

Error Types

:config_error - Configuration validation errors
:rpc_error - Remote procedure call errors
:node_error - Node selection or availability errors
:timeout_error - RPC timeout errors
:validation_error - Input validation errors

Examples

iex> EasyRpc.Error.config_error("Invalid timeout value")
%EasyRpc.Error{type: :config_error, message: "Invalid timeout value", details: nil}

iex> EasyRpc.Error.rpc_error("Connection refused", node: :node1@host)
%EasyRpc.Error{type: :rpc_error, message: "Connection refused", details: [node: :node1@host]}

Summary

Types

error_type()

t()

Functions

config_error(message, details \\ [])

Creates a configuration error.

format(error)

Formats an error into a human-readable string.

log(error, level \\ :error)

Logs an error using Logger.

node_error(message, details \\ [])

Creates a node error.

raise!(error)

raise!(type, message, details \\ [])

Raises an error with the given type and message.

rpc_error(message, details \\ [])

Creates an RPC error.

timeout_error(message, details \\ [])

Creates a timeout error.

validation_error(message, details \\ [])

Creates a validation error.

wrap_exception(exception, details \\ [])

Wraps a caught exception into an EasyRpc.Error.

Types

error_type()

@type error_type() ::
  :config_error | :rpc_error | :node_error | :timeout_error | :validation_error

t()

@type t() :: %EasyRpc.Error{
  __exception__: true,
  details: keyword() | map() | nil,
  message: String.t(),
  type: error_type()
}

Functions

config_error(message, details \\ [])

@spec config_error(
  String.t() | term(),
  keyword()
) :: t()

Creates a configuration error.

format(error)

@spec format(t()) :: String.t()

Formats an error into a human-readable string.

Examples

iex> error = EasyRpc.Error.config_error("Invalid timeout")
iex> EasyRpc.Error.format(error)
"[EasyRpc.Error:config_error] Invalid timeout"

log(error, level \\ :error)

@spec log(t(), :error | :warning | :info | :debug) :: :ok

Logs an error using Logger.

Examples

EasyRpc.Error.log(error, :error)
EasyRpc.Error.log(error, :warning)

node_error(message, details \\ [])

@spec node_error(
  String.t() | term(),
  keyword()
) :: t()

Creates a node error.

raise!(error)

@spec raise!(t()) :: no_return()

raise!(type, message, details \\ [])

@spec raise!(error_type(), String.t(), keyword()) :: no_return()

Raises an error with the given type and message.

Examples

EasyRpc.Error.raise!(:config_error, "Invalid config")
EasyRpc.Error.raise!(error_struct)

rpc_error(message, details \\ [])

@spec rpc_error(
  String.t() | term(),
  keyword()
) :: t()

Creates an RPC error.

timeout_error(message, details \\ [])

@spec timeout_error(
  String.t() | term(),
  keyword()
) :: t()

Creates a timeout error.

validation_error(message, details \\ [])

@spec validation_error(
  String.t() | term(),
  keyword()
) :: t()

Creates a validation error.

wrap_exception(exception, details \\ [])

@spec wrap_exception(
  Exception.t(),
  keyword()
) :: t()

Wraps a caught exception into an EasyRpc.Error.

Examples

try do
  :erpc.call(node, mod, fun, args)
rescue
  e -> EasyRpc.Error.wrap_exception(e, node: node)
end