Struct Diagnostic 

pub struct Diagnostic {
    pub code: DiagnosticCode,
    pub severity: Severity,
    pub message: String,
    pub file: Option<PathBuf>,
    pub span: Option<SourceSpan>,
    pub secondary_spans: Vec<SourceSpan>,
    pub notes: Vec<String>,
    pub hints: Vec<String>,
}

A diagnostic message emitted during analysis or scheduling

Diagnostics are structured data representing errors, warnings, hints, or informational messages. The message text is fully rendered at emission time according to the specification in DIAGNOSTICS.md.

Example

use utf8proj_core::{Diagnostic, DiagnosticCode, Severity};

let diagnostic = Diagnostic::new(
    DiagnosticCode::W001AbstractAssignment,
    "task 'api_dev' is assigned to abstract profile 'developer'"
);

assert_eq!(diagnostic.severity, Severity::Warning);
assert_eq!(diagnostic.code.as_str(), "W001");

Fields

code: DiagnosticCode

The diagnostic code

severity: Severity

Severity level (derived from code by default)

message: String

The primary message (fully rendered)

file: Option<PathBuf>

Source file path (if applicable)

span: Option<SourceSpan>

Primary source span (if applicable)

secondary_spans: Vec<SourceSpan>

Additional spans for related locations

notes: Vec<String>

Additional notes (displayed after the main message)

hints: Vec<String>

Hints for fixing the issue

Implementations

impl Diagnostic

pub fn new(code: DiagnosticCode, message: impl Into<String>) -> Self

Create a new diagnostic with the given code and message

Severity is derived from the diagnostic code’s default.

pub fn error(code: DiagnosticCode, message: impl Into<String>) -> Self

Create an error diagnostic

pub fn warning(code: DiagnosticCode, message: impl Into<String>) -> Self

Create a warning diagnostic

pub fn with_file(self, file: impl Into<PathBuf>) -> Self

Set the source file

pub fn with_span(self, span: SourceSpan) -> Self

Set the primary source span

pub fn with_secondary_span(self, span: SourceSpan) -> Self

Add a secondary span

pub fn with_note(self, note: impl Into<String>) -> Self

Add a note

pub fn with_hint(self, hint: impl Into<String>) -> Self

Add a hint

pub fn is_error(&self) -> bool

Returns true if this is an error-level diagnostic

pub fn is_warning(&self) -> bool

Returns true if this is a warning-level diagnostic

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Diagnostic

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Diagnostic

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.