Flux Error v0.0.1 FluxError exception View Source

Exception module to improve error management.

Link to this section Summary

Types

t()

FluxError exception struct.

Functions

from(error, reason \\ :unhandled_error, metadata \\ [])

Create FluxError.t/0 from an external error.

log(error, stacktrace)

Log the error, returning the FluxError.t/0.

message(error)

Extract the error message.

new(reason, metadata \\ [])

Create FluxError.t/0.

to_map(error, opts \\ [])

Generate a map/0 based on error data.

Link to this section Types

t()

(since 0.0.1)

t() :: %FluxError{__exception__: term(), metadata: map(), reason: atom()}

FluxError exception struct.

The :reason will be used to identify the error message.

The :metadata will be used to inject data into the error message.

Link to this section Functions

from(error, reason \\ :unhandled_error, metadata \\ [])

(since 0.0.1)

from(Exception.t() | atom(), atom(), keyword()) :: t()

Create FluxError.t/0 from an external error.

Parameters

error - An atom/0 or Exception.t/0. If atom/0 which will be inserted at the metadata :detail key. If Exception.t/0, it will try to get the :reason value, otherwise it will generate a String.t/0 from the Exception.t/0 map.
reason - An atom/0 identifying the error. Defaults to :unhandled_error.
metadata - A keyword/0 with detailed data about the error. Defaults to empty list/0.

Examples

iex> FluxError.from(:external_failure, :external_module_failed, module: :external)
%FluxError{
  reason: :external_module_failed,
  metadata: %{
    detail: :external_failure,
    module: :external
  }
}

log(error, stacktrace)

(since 0.0.1)

log(Exception.t() | atom(), Exception.stacktrace()) :: t()

Log the error, returning the FluxError.t/0.

It will create a FluxError.t/0 if error is an atom/0 or other Exception.t/0 using FluxError.from/3.

The log will have two metadata values:

:error_metadata - The inspection of the FluxError.t/0 :metadata key.
:error_stacktrace - The error stacktrace.

Parameters

error - An atom/0 or Exception.t/0.
stacktrace - The Exception.stacktrace/0 of the error.

Examples

iex> try do
...>   throw(:failed)
...> catch
...>   error -> FluxError.log(error, __STACKTRACE__)
...> end
%FluxError{
  reason: :unhandled_error,
  metadata: %{
    detail: :failed
  }
}

message(error)

(since 0.0.1)

message(Exception.t() | atom()) :: String.t()

Extract the error message.

It will create a FluxError.t/0 if error is an atom/0 or other Exception.t/0 using FluxError.from/3.

The message is extracted based on :messages_module app config. Check FluxError for more information.

Parameters

error - An atom/0 or Exception.t/0.

Examples

iex> FluxError.message(:failed)
"triggered unhandled error"

new(reason, metadata \\ [])

(since 0.0.1)

new(atom(), keyword()) :: t()

Create FluxError.t/0.

Parameters

reason - An atom/0 identifying the error.
metadata - A keyword/0 with detailed data about the error. Defaults to empty list/0.

Examples

iex> FluxError.new(:failed, level: :severe)
%FluxError{
  reason: :failed,
  metadata: %{
    level: :severe
  }
}

to_map(error, opts \\ [])

(since 0.0.1)

to_map(Exception.t() | atom(), keyword() | nil) :: map()

Generate a map/0 based on error data.

It will create a FluxError.t/0 if error is an atom/0 or other Exception.t/0 using FluxError.from/3.

Parameters

error - An atom/0 or Exception.t/0.
opts - A keyword/0 with message options. Check FluxError.Messages for more information. Defaults to empty list/0

Examples

iex> FluxError.to_map(:failed)
%{
  error: true,
  id: :unhandled_error,
  message: "triggered unhandled error",
  message_raw: "triggered unhandled error",
  metadata: %{
    detail: :failed
  }
}