Struct Diagnostic 

pub struct Diagnostic {
    pub severity: Severity,
    pub code: DiagnosticCode,
    pub message: String,
    pub span: Option<SourceSpan>,
    pub notes: Vec<DiagnosticNote>,
    pub suggestions: Vec<Suggestion>,
}

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

Examples

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

let diagnostic = Diagnostic::error(DiagnosticCode("E001"), "boom");

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

Fields

severity: Severity

code: DiagnosticCode

message: String

span: Option<SourceSpan>

notes: Vec<DiagnosticNote>

suggestions: Vec<Suggestion>

Implementations

impl Diagnostic

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

Construct an error diagnostic without a span.

Examples

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

let diagnostic = Diagnostic::error(DiagnosticCode("E001"), "boom");

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

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

Attach a span to a diagnostic.

Examples

use std::path::PathBuf;

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

let diagnostic = Diagnostic::error(DiagnosticCode("E001"), "boom")
    .with_span(SourceSpan::placeholder(PathBuf::from("main.mos")));

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

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.