report

Documentation

Overview

Package report renders verdicts as human-readable text or JSON.

The human format is hand-rolled and forecast-first: the Direct P2P line leads so the WebRTC-developer persona gets the answer on line 1. The JSON format is a public contract pinned by golden-file tests; only additive changes are permitted after v0.1. See docs/design.md §UX shape.

Index

• func Render(w io.Writer, v classify.Verdict, probes []probe.Result, format Format) error
• type Format

Functions

func Render

func Render(w io.Writer, v classify.Verdict, probes []probe.Result, format Format) error

Render writes a Verdict + probe results to w in the requested format. Filtering data is consumed via v.Filtering and v.FilteringTestedAgainst (already populated by classify.Classify). Writer and encoding errors are returned verbatim.

Types

type Format

type Format int

Format selects the output format for Render.

const (
	// FormatHuman produces a screen-friendly report leading with the forecast.
	FormatHuman Format = iota
	// FormatJSON produces the machine-readable report. The schema is a public
	// contract from v0.1 onward; only additive changes permitted.
	FormatJSON
)