Struct Diagnostic 

pub struct Diagnostic { /* private fields */ }

A user-facing diagnostic (manifest §16, §31).

Identity and default severity come from a 'static DiagnosticDef in codes; the instance carries the resolved severity (today always the def’s default, later a config override) so rendering never has to consult the def. Fields are private — construct via Diagnostic::simple or Diagnostic::new.

Examples

use mos_core::{Diagnostic, Severity, codes};

let diagnostic = Diagnostic::simple(&codes::MOS0010, None, "boom");

assert_eq!(diagnostic.severity(), Severity::Error);
assert_eq!(diagnostic.def().code().to_string(), "MOS0010");

Implementations

impl Diagnostic

pub fn new( def: &'static DiagnosticDef, severity: Severity, span: Option<SourceSpan>, message: impl Into<String>, ) -> Self

Full constructor: the caller supplies the resolved severity. The future config resolver uses this; nothing has to crack open the struct.

Examples

use mos_core::{Diagnostic, Severity, codes};

// Promote a warning-by-default code to an error.
let d = Diagnostic::new(&codes::MOS0028, Severity::Error, None, "promoted");
assert_eq!(d.severity(), Severity::Error);

pub fn simple( def: &'static DiagnosticDef, span: Option<SourceSpan>, message: impl Into<String>, ) -> Self

Convenience: severity defaults to def.default_severity().

Examples

use mos_core::{Diagnostic, Severity, codes};

let d = Diagnostic::simple(&codes::MOS0018, None, "substituted Noto Sans");
assert_eq!(d.severity(), Severity::Notice);

pub fn with_annotation(self, annotation: DiagnosticAnnotation) -> Self

Attach a sub-message annotation, builder-style.

Examples

use mos_core::{Diagnostic, DiagnosticAnnotation, codes};

let d = Diagnostic::simple(&codes::MOS0033, None, "unknown label")
    .with_annotation(DiagnosticAnnotation::Help("did you mean `@intro`?".to_owned()));
assert_eq!(d.annotations().len(), 1);

pub fn with_suggestion(self, suggestion: Suggestion) -> Self

Attach a machine-actionable Suggestion, builder-style.

Examples

use std::path::PathBuf;

use mos_core::{Diagnostic, SourceSpan, Suggestion, codes};

let span = SourceSpan::new(PathBuf::from("main.mos"), 4, 10);
let d = Diagnostic::simple(&codes::MOS0033, None, "unknown label")
    .with_suggestion(Suggestion::new(span, "@intro"));
assert_eq!(d.suggestions().len(), 1);

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

Attach a span, builder-style.

Examples

use std::path::PathBuf;

use mos_core::{Diagnostic, SourceSpan, codes};

let span = SourceSpan::new(PathBuf::from("main.mos"), 4, 10);
let diagnostic = Diagnostic::simple(&codes::MOS0033, None, "unknown label")
    .with_span(span.clone());

assert_eq!(diagnostic.span(), Some(&span));

pub fn def(&self) -> &'static DiagnosticDef

The registry definition behind this diagnostic.

Examples

use mos_core::{Diagnostic, codes};

let diagnostic = Diagnostic::simple(&codes::MOS0033, None, "unknown label");

assert_eq!(diagnostic.def().code(), codes::MOS0033.code());

pub fn severity(&self) -> Severity

The resolved severity carried by this instance.

Examples

use mos_core::{Diagnostic, Severity, codes};

let diagnostic = Diagnostic::simple(&codes::MOS0033, None, "unknown label");

assert_eq!(diagnostic.severity(), Severity::Error);

pub fn span(&self) -> Option<&SourceSpan>

The primary span, if any.

Examples

use mos_core::{Diagnostic, codes};

let diagnostic = Diagnostic::simple(&codes::MOS0033, None, "unknown label");

assert!(diagnostic.span().is_none());

pub fn message(&self) -> &str

The primary message.

Examples

use mos_core::{Diagnostic, codes};

let diagnostic = Diagnostic::simple(&codes::MOS0033, None, "unknown label");

assert_eq!(diagnostic.message(), "unknown label");

pub fn annotations(&self) -> &[DiagnosticAnnotation]

The attached sub-message annotations, in attach order.

Examples

use mos_core::{Diagnostic, DiagnosticAnnotation, codes};

let diagnostic = Diagnostic::simple(&codes::MOS0033, None, "unknown label")
    .with_annotation(DiagnosticAnnotation::Help("declare `<intro>` first".to_owned()));

assert_eq!(diagnostic.annotations().len(), 1);

pub fn suggestions(&self) -> &[Suggestion]

The attached machine-actionable suggestions, in attach order.

Examples

use std::path::PathBuf;

use mos_core::{Diagnostic, SourceSpan, Suggestion, codes};

let span = SourceSpan::new(PathBuf::from("main.mos"), 4, 10);
let diagnostic = Diagnostic::simple(&codes::MOS0033, None, "unknown label")
    .with_suggestion(Suggestion::new(span, "@intro"));

assert_eq!(diagnostic.suggestions().len(), 1);

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 Display for Diagnostic

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

Formats the value using the given formatter.

impl Error for Diagnostic

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.