Caravela.DSLError exception (Caravela v0.9.2)

Copy Markdown View Source

Raised from Caravela DSL macros when a caller uses them incorrectly. Carries a four-part message (what went wrong, what Caravela got, a suggested fix, a docs URL). See Caravela.Errors for helpers that build one of these from a Macro.Env.

Summary

Types

t()

@type t() :: %Caravela.DSLError{
  __exception__: true,
  docs_url: String.t() | nil,
  message: String.t(),
  snippet: String.t() | nil,
  suggestion: String.t() | nil
}