Struct Diagnostic 

pub struct Diagnostic { /* private fields */ }

A rich diagnostic message with source location information.

Diagnostics provide detailed information about errors and warnings, including:

• A severity level
• An optional error code for documentation and searchability
• A primary message describing the issue
• One or more labeled source spans
• Optional help text with suggestions

Example

error[E301]: cannot override type `Rectangle`
  --> src/main.orr:10:1
   |
10 | type Rectangle = Oval[fill_color="red"];
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ type override not supported
   |
   = help: built-in types cannot be redefined

Implementations

impl Diagnostic

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

Create an error diagnostic.

Example

let span = Span::new(0..10);
let diag = Diagnostic::error("undefined type `Foo`")
    .with_code(ErrorCode::E300)
    .with_label(span, "not found")
    .with_help("did you mean `Bar`?");

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

Create a warning diagnostic.

Example

let span = Span::new(0..10);
let diag = Diagnostic::warning("unused component")
    .with_label(span, "this component is never referenced")
    .with_help("consider removing it");

pub fn severity(&self) -> Severity

Get the severity of this diagnostic.

pub fn code(&self) -> Option<ErrorCode>

Get the error code, if any.

pub fn message(&self) -> &str

Get the primary message.

pub fn labels(&self) -> &[Label]

Get all labels attached to this diagnostic.

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

Get the help text, if any.

pub fn with_code(self, code: ErrorCode) -> Self

Set the error code.

pub fn with_label(self, span: Span, message: impl Into<String>) -> Self

Add a primary label to this diagnostic.

pub fn with_secondary_label( self, span: Span, message: impl Into<String>, ) -> Self

Add a secondary label to this diagnostic.

pub fn with_help(self, help: impl Into<String>) -> Self

Set the help text.

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.