error v0.4.2 Error View Source

Model domain and infrastructure errors as regular data.

Link to this section Summary

Types

domain()

domain(a)

infra()

infra(a)

kind()

reason()

t()

t(a)

Functions

caused_by(arg1)

Extract the cause of an error (of type Error.t()).

details(arg1)

Return the map of detailed information supplied at Error creation.

domain(reason, details \\ %{})

Create a domain error, with a reason and optional details.

flatten(e)

Flattens the given error and all its nested causes into a list.

infra(reason, details \\ %{})

Create an infra error, with a reason and optional details.

is_domain_error(x)

A guard to use in order to pattern match errors. Will match on Domain errors, but not Infra errors.

is_error(x)

A guard to use in order to pattern match errors. Will match on both Infra and Domain Errors.

is_infra_error(x)

A guard to use in order to pattern match errors. Will match on Infra errors, but not Domain errors.

kind(arg1)

Determine whether a given Error is a domain or infra error.

map_details(error, f)

Map a function on the details map in an Error.

reason(arg1)

Return the reason the Error was created with.

root_cause(e)

Extracts the root cause of the given error.

to_map(e)

Convert an Error to an Elixir map.

wrap(inner, outer)

Wrap a higher-level error 'on top' of a lower-level error.

Link to this section Types

domain()

domain() :: domain(any())

domain(a)

domain(a) :: %Error.DomainError{caused_by: term(), details: a, reason: reason()}

infra()

infra() :: infra(any())

infra(a)

infra(a) :: %Error.InfraError{caused_by: term(), details: a, reason: reason()}

kind()

kind() :: :domain | :infra

reason()

reason() :: atom()

t()

t() :: t(any())

t(a)

t(a) ::
  %Error.DomainError{caused_by: term(), details: a, reason: reason()}
  | %Error.InfraError{caused_by: term(), details: a, reason: reason()}

Link to this section Functions

caused_by(arg1)

caused_by(t(a)) :: FE.Maybe.t(t(a)) when a: any()

Extract the cause of an error (of type Error.t()).

Think of this as inspecting deeper into the stack trace.

details(arg1)

details(t(a)) :: a when a: any()

Return the map of detailed information supplied at Error creation.

domain(reason, details \\ %{})

domain(atom(), a) :: t(a) when a: any()

Create a domain error, with a reason and optional details.

flatten(e)

flatten(t(a)) :: [t(a)] when a: any()

Flattens the given error and all its nested causes into a list.

The given error is always the first element of resulting list.

infra(reason, details \\ %{})

infra(atom(), a) :: t(a) when a: any()

Create an infra error, with a reason and optional details.

is_domain_error(x)

(macro)

A guard to use in order to pattern match errors. Will match on Domain errors, but not Infra errors.

is_error(x)

(macro)

A guard to use in order to pattern match errors. Will match on both Infra and Domain Errors.

is_infra_error(x)

(macro)

A guard to use in order to pattern match errors. Will match on Infra errors, but not Domain errors.

kind(arg1)

kind(t()) :: kind()

Determine whether a given Error is a domain or infra error.

map_details(error, f)

map_details(t(a), (a -> b)) :: t(b) when a: any(), b: any()

Map a function on the details map in an Error.

Useful for adding extra details, modifying exisint ones, or removing them.

reason(arg1)

reason(t()) :: reason()

Return the reason the Error was created with.

root_cause(e)

root_cause(t(a)) :: t(a) when a: any()

Extracts the root cause of the given error.

The root cause of an error without an underlying cause is the error itself.

to_map(e)

to_map(t()) :: map()

Convert an Error to an Elixir map.

wrap(inner, outer)

wrap(t(a), t(a)) :: t(a) when a: any()

Wrap a higher-level error 'on top' of a lower-level error.

Think of this as a stack trace, but in domain-model terms.