Skip to main content

Module output

Module output 

Source
Expand description

Output format selection for the handful of commands that support --output json (history list/history show and tune/simulate’s final summary line — see AGENTS.md’s cli-automation section for why exactly these three).

Mirrors opcda-bridge-client’s output.rs in spirit (a small OutputFormat enum plus a format_error helper), but deliberately without its generic render<T: Tabled + Serialize> function: bhtune-cli’s commands print bespoke, multi-section reports (history show’s run detail, tune’s calculated-PID listing), not flat single-row-type tables, so there is no one shared row shape to hand to a generic renderer. Each command instead builds its own JSON-serializable summary type and calls serde_json::to_string_pretty directly — see commands::history/commands::tune.

Enums§

OutputFormat
How a command’s result is printed. Only commands documented in this module’s doc comment honor this; every other command always prints its existing human-readable text.

Functions§

format_error
Format an error for display, matching the requested output format.