Struct Diagnostic 

pub struct Diagnostic { /* private fields */ }

A user-facing issue found in Achitekfile source.

Diagnostics carry stable machine-readable metadata that downstream tools can map into their own reporting formats. For example, achitek-ls can convert this type into an LSP diagnostic without defining its own Achitekfile diagnostic codes.

Examples

let source = r#"
blueprint {
  version = "1.0.0"
  name = "web-app"
}

prompt "project_name" {
  help = "Project name"
}
"#;

let analysis = achitekfile::analyze(source)?;
let diagnostic = &analysis.diagnostics()[0];

assert_eq!(diagnostic.code(), achitekfile::DiagnosticCode::MissingPromptType);
assert_eq!(diagnostic.severity(), achitekfile::Severity::Error);
assert_eq!(diagnostic.kind(), achitekfile::DiagnosticKind::Semantic);

Implementations

impl Diagnostic

pub fn code(&self) -> DiagnosticCode

Returns the stable diagnostic code.

pub fn severity(&self) -> Severity

Returns how strongly tooling should surface this diagnostic.

pub fn message(&self) -> &str

Returns the user-facing diagnostic message.

pub fn help(&self) -> Option<&str>

Returns optional remediation guidance for this diagnostic.

pub fn range(&self) -> TextRange

Returns the source range associated with this diagnostic.

pub fn kind(&self) -> DiagnosticKind

Returns the broad analysis layer that produced this 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.

impl Hash for Diagnostic

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Diagnostic

fn eq(&self, other: &Diagnostic) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Diagnostic

impl StructuralPartialEq for Diagnostic