Aleph::Diagnostic Struct Reference

Fully accumulated diagnostic. More...

#include <ah-diagnostics.H>

Collaboration diagram for Aleph::Diagnostic:

Public Attributes
Diagnostic_Severity	severity = Diagnostic_Severity::Error
	Severity level.
std::string	code
	Optional stable code such as E001.
std::string	message
	Main headline message.
DynArray< Diagnostic_Label >	labels
	Source annotations.
DynArray< std::string >	notes
	Additional notes.
DynArray< std::string >	help
	Suggested next actions.

Detailed Description

Fully accumulated diagnostic.

The message is the headline shown next to the severity. Labels, notes, and help entries provide source and remediation context.

Definition at line 91 of file ah-diagnostics.H.

Member Data Documentation

code

std::string Aleph::Diagnostic::code

Optional stable code such as E001.

Definition at line 94 of file ah-diagnostics.H.

Referenced by Aleph::Diagnostic_Builder::code(), TEST(), TEST(), TEST(), TEST(), and TEST().

help

DynArray<std::string> Aleph::Diagnostic::help

Suggested next actions.

Definition at line 98 of file ah-diagnostics.H.

Referenced by Aleph::Diagnostic_Builder::help().

labels

DynArray<Diagnostic_Label> Aleph::Diagnostic::labels

Source annotations.

Definition at line 96 of file ah-diagnostics.H.

Referenced by Aleph::Diagnostic_Engine::append_diagnostic(), Aleph::Diagnostic_Builder::primary(), Aleph::Diagnostic_Engine::render_secondary_labels(), and Aleph::Diagnostic_Builder::secondary().

message

std::string Aleph::Diagnostic::message

Main headline message.

Definition at line 95 of file ah-diagnostics.H.

Referenced by Aleph::Diagnostic_Engine::append_diagnostic(), TEST(), TEST(), TEST(), and TEST().

notes

DynArray<std::string> Aleph::Diagnostic::notes

Additional notes.

Definition at line 97 of file ah-diagnostics.H.

Referenced by Aleph::Diagnostic_Builder::note().

severity

Diagnostic_Severity Aleph::Diagnostic::severity = Diagnostic_Severity::Error

Severity level.

Definition at line 93 of file ah-diagnostics.H.

Referenced by Aleph::Diagnostic_Engine::append_diagnostic().

---

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

• ah-diagnostics.H