Skip to main content

Module render

aperion_shield::explain

Module render 

Source
Expand description

Output formats for --explain.

Three render targets, all driven off the same ExplainReport captured by crate::explain::explain:

  • text – terminal-friendly, fixed-width, designed to render cleanly without ANSI in any 80-column shell.
  • markdown – GitHub-flavoured. Drops into a PR review comment with collapsible details for the rule list.
  • json – a stable schema (NOT the engine’s internal struct) suitable for piping into other tooling.

Structs§

AdjustmentSignalsJson
ExplainJson
ExplainReport
Everything --explain needs to render. Built by explain::explain, passed by reference to the format functions. Captured by value so callers can pickle reports across format selections without rebuilding the engine state.
RuleMatchJson

Enums§

DecisionJson
ExplainFormat
Output format selector for --explain-format.

Functions§

render