Figler.Render.Warning (figler v0.1.0-beta.1)

Copy Markdown View Source

A structured rendering diagnostic.

Warning codes are stable within the beta API. :severity classifies why a render is not exact; :context exposes structured details when available; and :value preserves the original backend-neutral diagnostic value for compatibility and debugging.

All warnings are returned in non-strict render metadata. strict: true rejects the same warning list with {:error, {:unsupported_render_features, warnings}}.

Summary

Types

severity()
t()

Functions

code(value)

Returns the stable warning code represented by a diagnostic value.

severity(code)

Returns the severity classification for a stable warning code.

Types

severity()

@type severity() ::
  :approximation | :unsupported | :substitution | :invalid | :missing

t()

@type t() :: %Figler.Render.Warning{
  code: atom(),
  context: map(),
  feature: atom(),
  guid: String.t(),
  severity: severity(),
  value: term()
}

Functions

code(value)

@spec code(term()) :: atom()

Returns the stable warning code represented by a diagnostic value.

severity(code)

@spec severity(atom()) :: severity()

Returns the severity classification for a stable warning code.