RustQ.Diagnostic (rustq v1.0.0-rc.19)

Structured RustQ diagnostic data for lowering/rendering failures.

Summary

Types

t()

Functions

defrust(kind, node, message, opts \\ [])

Raises a RustQ.Diagnostic.Error for a defrust definition that cannot be built.

lower(kind, node, message, opts \\ [])

Raises a RustQ.Diagnostic.Error for a lowering failure at node.

new(phase, kind, node, message, opts \\ [])

Builds structured diagnostic data for extension and tooling errors.

render(kind, node, message, opts \\ [])

Raises a RustQ.Diagnostic.Error for Rust that fails to render.

Types

t()

@type t() :: %RustQ.Diagnostic{
  details: map(),
  kind: atom(),
  message: String.t(),
  node: Macro.t() | nil,
  phase: atom(),
  snippet: String.t() | nil,
  suggestion: String.t() | nil
}

Functions

defrust(kind, node, message, opts \\ [])

@spec defrust(atom(), Macro.t(), String.t(), keyword()) :: no_return()

Raises a RustQ.Diagnostic.Error for a defrust definition that cannot be built.

lower(kind, node, message, opts \\ [])

@spec lower(atom(), Macro.t(), String.t(), keyword()) :: no_return()

Raises a RustQ.Diagnostic.Error for a lowering failure at node.

new(phase, kind, node, message, opts \\ [])

@spec new(atom(), atom(), Macro.t() | nil, String.t(), keyword()) :: t()

Builds structured diagnostic data for extension and tooling errors.

render(kind, node, message, opts \\ [])

@spec render(atom(), term(), String.t(), keyword()) :: no_return()

Raises a RustQ.Diagnostic.Error for Rust that fails to render.