@spec compensation_error(String.t(), keyword() | map()) ::
  Jido.Error.CompensationError.t()

Creates a compensation error.

Options

• :original_error - The error that triggered compensation
• :compensated - Whether compensation succeeded (default: false)
• :result - Result from successful compensation
• :details - Additional context map

@spec execution_error(String.t(), keyword() | map()) :: Jido.Error.ExecutionError.t()

Creates an execution error.

Options

• :phase - Where failure occurred: :execution, :planning
• :details - Additional context map
• Any other keys are merged into details

@spec extract_message(any()) :: String.t()

Extracts the message string from a nested error structure.

@spec format_nimble_config_error(any(), String.t(), module()) :: String.t()

Formats a NimbleOptions configuration error.

@spec format_nimble_validation_error(any(), String.t(), module()) :: String.t()

Formats a NimbleOptions validation error for parameters.

@spec internal_error(String.t(), keyword() | map()) :: Jido.Error.InternalError.t()

Creates an internal error.

Options

• :details - Additional context map

@spec retryable?(term()) :: boolean()

Returns whether an error is safe to retry by default.

Explicit :retry, :retryable, and :retryable? boolean hints in structured details override the default classification.

@spec routing_error(String.t(), keyword() | map()) :: Jido.Error.RoutingError.t()

Creates a routing error.

Options

• :target - The intended routing target
• :details - Additional context map

@spec timeout_error(String.t(), keyword() | map()) :: Jido.Error.TimeoutError.t()

Creates a timeout error.

Options

• :timeout - The timeout value in milliseconds
• :details - Additional context map

@spec to_map(any()) :: map()

Converts an error into a stable, public map.

The returned map is suitable for transport and reporting boundaries. It includes bounded, sanitized details and never includes stacktraces by default.

Details traverse at most 4 container levels, with up to 20 entries per map or list. Scalar leaves are kept at the depth limit, so validation paths retain field names and list indexes. Strings are limited to 512 characters plus a truncation suffix. Invalid UTF-8 binaries use bounded inspection. Deeper containers and opaque terms are replaced with [DEPTH_LIMIT].

Traverses errors, calling fun for each leaf error, and returns a nested map of results grouped by each error's path.

See Splode.traverse_errors/2 for full documentation.

Example

iex> Elixir.Jido.Error.traverse_errors(error, fn error ->
...>   Exception.message(error)
...> end)
%{name: ["name is required"]}

Raises an error if the result is an error, otherwise returns the result

Alternatively, you can use the defsplode macro, which does this automatically.

Options

• :error_opts - Options to pass to to_error/2 when converting the returned error
• :unknown_error_opts - Options to pass to the unknown error if the function returns only :error. not necessary if your function always returns {:error, error}.

Examples

def function(arg) do

case do_something(arg) do
  :success -> :ok
  {:success, result} -> {:ok, result}
  {:error, error} -> {:error, error}
end

end

def function!(arg) do

YourErrors.unwrap!(function(arg))

end

@spec validation_error(String.t(), keyword() | map()) ::
  Jido.Error.ValidationError.t()

Creates a validation error.

Options

• :kind - Category: :input, :action, :sensor, :config, :state_size
• :subject - The invalid value
• :field - Alias for :subject (for input validation)
• :action - Alias for :subject with kind: :action
• :sensor - Alias for :subject with kind: :sensor
• :details - Additional context map

Examples

validation_error("Invalid email", field: :email)
validation_error("Unknown action", kind: :action, subject: MyAction)