Module tiger_lib::report

Structs

• Errors
• LogReport
  Describes a report about a potentially problematic situation that can be logged.
• PointedMessage

Enums

• Confidence
  Mostly invisible in the output. User can filter by minimum confidence level. This would be a dial for how many false positives they’re willing to put up with.
• Severity
  Determines the output colour. User can also filter by minimum severity level: e.g. don’t show me Info-level messages.

Functions

• add_loaded_mod_root
  Record dir as the path to a secondary mod to be loaded before the one being validated. label is what this mod should be called in the error reports; ideally only a few characters long.
• disable_ansi_colors
  Disable color in the output.
• emit_reports
  Print all the stored reports to the error output. Set json if they should be printed as a JSON array. Otherwise they are printed in the default output format.
• log
  Store an error report to be emitted when emit_reports is called.
• set_max_line_length
  TODO:
• set_mod_root
  Record dir as the path to the mod being validated.
• set_output_file
  Configure the error reports to be written to this file instead of to stdout.
• set_output_style
  Override the default OutputStyle. (Controls ansi colors)
• set_show_loaded_mods
  Configure the error reporter to show errors that are in extra loaded mods. Normally those are filtered out, to only show errors that involve the mod’s code.
• set_show_vanilla
  Configure the error reporter to show errors that are in the base game code. Normally those are filtered out, to only show errors that involve the mod’s code.
• set_vanilla_dir
  Record dir as the path to the base game files. It should be a path to the directory containing the game directory.
• take_reports
  Extract the stored reports, sort them, and return them as a vector of LogReport. The stored reports will be left empty.
• will_maybe_log
  Tests whether the report might be printed. If false, the report will definitely not be printed.