errors v0.1.0 Errors View Source

Link to this section Summary

Cause recursively unfurls a passed-in value that implements Cause

Construct a new WrappedError

Wrap an error and message into a WrappedError

cause(error)

cause(error :: Errors.Cause.t | any) :: Exception.t | any

Cause recursively unfurls a passed-in value that implements Cause.

It will return the first value that does not implement Cause.

new(message \\ "") (macro)

new(message :: String.t) :: Macro.t

Construct a new WrappedError.

Note that the returned WrappedError will have its error field set to nil. If you want to wrap an existing error, use Errors.wrap/2.

wrap(error, message \\ "") (macro)

wrap(error :: Exception.t, message :: String.t) :: Macro.t

Wrap an error and message into a WrappedError.

This macro automatically passes ENV to the WrappedError. Thus, you should use this function over %WrappedError{} when possible.