Maverick v0.1.0
Maverick

Maverick.Exception protocol (Maverick v0.1.0) View Source

A protocol that allows associating http status codes with specific exceptions and providing a fallback operation in the form of an {module, function, arguments} tuple to attempt recovery.

By default, the protocol looks for an implementation on the given exception, then checkds for the :error_code field, or else returns 500 and falls back to returning a JSON-encoded map with the error code and a descriptive error message.

Link to this section Summary

Types

fallback()
t()

Functions

error_code(exception)

Receives an exception and returns an HTTP status code.

fallback(exception)

Receives an exception and returns the fallback operation, represented by a map with an identifying tag (primarily for debugging and logging) and a 3-tuple with the module, function, and arguments to execute to attempt recovery.

Link to this section Types

Link to this type

fallback()

View Source

Specs

fallback() :: %{tag: String.t(), handler: {module(), atom(), list()}}
Link to this type

t()

View Source

Specs

t() :: term()

Link to this section Functions

Link to this function

error_code(exception)

View Source

Specs

error_code(t()) :: 100..999

Receives an exception and returns an HTTP status code.

Link to this function

fallback(exception)

View Source

Specs

fallback(t()) :: fallback()

Receives an exception and returns the fallback operation, represented by a map with an identifying tag (primarily for debugging and logging) and a 3-tuple with the module, function, and arguments to execute to attempt recovery.