Struct Diagnostic

pub struct Diagnostic {
    pub severity: Severity,
    pub headline: String,
    pub file_path: Option<String>,
    pub context: Option<Context>,
    pub notes: Vec<String>,
}

A diagnostic over some source file.

Fields

severity: Severity

The diagnostic severity.

headline: String

The diagnostic headline.

file_path: Option<String>

The diagnostic filepath.

context: Option<Context>

The diagnostic context.

notes: Vec<String>

The nodes.

Implementations

impl Diagnostic

pub fn new<S: ToString>(severity: Severity, headling: S) -> Self

Create a new diagnostic.

pub fn error<S: ToString>(headling: S) -> Self

Create an error diagnostic.

pub fn warning<S: ToString>(headling: S) -> Self

Create a warning diagnostic.

pub fn file_path<S: ToString>(self, path: S) -> Self

Set the filepath of the diagnostic.

pub fn add_note<S: ToString>(self, note: S) -> Self

Add a note to the diagnostic.

pub fn context(self, context: Context) -> Self

Set the context of the diagnostic.

Trait Implementations

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.