One problem discovered by a validation check. More...

#include <validate.hpp>

Collaboration diagram for reusex::core::ValidationIssue:

[legend]

Public Attributes
std::string	check
	Machine-readable check id (e.g. "orphaned_passport").
std::string	message
	Human-readable description.
ValidationSeverity	severity = ValidationSeverity::error
std::string	hint
	What the user should run to fix it, or empty when there is no mechanical resolution.
std::string	artifact
	The pipeline artifact this issue is about, when it is about one; empty otherwise.
std::vector< std::string >	commands
	The same resolution as hint, as an ordered list of commands rather than prose.

Detailed Description

One problem discovered by a validation check.

Definition at line 24 of file validate.hpp.

Member Data Documentation

◆ artifact

std::string reusex::core::ValidationIssue::artifact

The pipeline artifact this issue is about, when it is about one; empty otherwise.

Surfaced separately so a front end can say "inputs missing: cloud, normals" without regex-ing message, which is prose and is allowed to change wording (#305).

Definition at line 39 of file validate.hpp.

◆ check

std::string reusex::core::ValidationIssue::check

Machine-readable check id (e.g. "orphaned_passport").

Definition at line 25 of file validate.hpp.

◆ commands

std::vector<std::string> reusex::core::ValidationIssue::commands

The same resolution as hint, as an ordered list of commands rather than prose.

hint is formatted for a terminal (it is multi-line when several commands are needed); a GUI needs the steps, not the layout, and parsing them back out of the prose would be a second source of truth (#305).

Definition at line 44 of file validate.hpp.

◆ hint

std::string reusex::core::ValidationIssue::hint

What the user should run to fix it, or empty when there is no mechanical resolution.

For stage-input issues this is DERIVED from the stage contract table (#246) — the producing stage of every missing artifact, walked backwards to the first prerequisite that is actually satisfied — so the "run these commands in order" guidance cannot drift out of step with the checks themselves.

Definition at line 34 of file validate.hpp.

◆ message

std::string reusex::core::ValidationIssue::message

Human-readable description.

Definition at line 26 of file validate.hpp.

◆ severity

ValidationSeverity reusex::core::ValidationIssue::severity = ValidationSeverity::error

Definition at line 27 of file validate.hpp.

The documentation for this struct was generated from the following file:

libs/reusex/include/core/validate.hpp

Public Attributes