error v0.1.0 Error View Source

Model domain and infrastructure errors as regular data.

Link to this section Summary

Types

kind()

reason()

t()

t(a)

Functions

Return the map of detailed information supplied at Error creation.

domain(reason, details \\ %{})

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

infra(reason, details \\ %{})

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

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.

Return the reason the Error was created with.

Convert an Error to an Elixir map.

Link to this section Types

kind()

kind() :: :domain | :infra

reason()

reason() :: atom()

t()

(opaque)

t()

t(a)

(opaque)

t(a)

Link to this section Functions

details(error)

details(t(a)) :: a when a: map()

Return the map of detailed information supplied at Error creation.

domain(reason, details \\ %{})

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

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

infra(reason, details \\ %{})

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

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

kind(error)

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: map(), b: map()

Map a function on the details map in an Error.

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

reason(error)

reason(t()) :: reason()

Return the reason the Error was created with.

to_map(error)

to_map(t()) :: map()

Convert an Error to an Elixir map.