Skip to main content

Module display

Module display 

Source
Expand description

Turning validation results into something a human or another program reads.

A ValidationIssue says what is wrong in machine-readable form. This module decides where it is (an IssueView) and how it is worded (an IssueNarrator). Both are traits, so a consumer can render a report in a world or a language this crate never anticipated.

Modules§

format
The format module: whole-report renderings.

Structs§

Bo4eView
Locates issues by BO4E field path.
EdifactView
Locates issues by EDIFACT segment path — the world the validator works in.
IssueDisplay
One issue resolved into a chosen view and wording.
TechnicalNarrator
The wording this repo has always used: technical, English, AHB vocabulary.

Traits§

IssueNarrator
How an issue is put into words.
IssueView
Which world an issue is addressed in.

Functions§

report_to_json
A report rendered for transport: every issue keeps message, code and category fields, narrated in the given view, alongside its structured kind.