Struct DiagnosticWrapper 

pub struct DiagnosticWrapper<K> {
    pub kind: K,
    /* private fields */
}

A compilation diagnostic (error or warning) with optional source location.

This is a generic wrapper that holds a diagnostic kind along with optional source location and rich diagnostic information (labels, notes, helps).

Use the type aliases CompileError and CompileWarning for the specific error and warning types.

Diagnostics can include rich information using the builder methods:

CompileError::new(ErrorKind::TypeMismatch { ... }, span)
    .with_label("expected because of this", other_span)
    .with_note("types must match exactly")
    .with_help("consider adding a type conversion")

Fields

kind: K

The specific kind of diagnostic.

Implementations

impl<K> DiagnosticWrapper<K>

pub fn new(kind: K, span: Span) -> Self

Create a new diagnostic with the given kind and span.

pub fn without_span(kind: K) -> Self

Create a diagnostic without a source location.

Use this for diagnostics that don’t correspond to a specific source location, such as “no main function found” or linker errors.

pub fn has_span(&self) -> bool

Returns true if this diagnostic has source location information.

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

Get the span, if present.

pub fn diagnostic(&self) -> &Diagnostic

Get the diagnostic information.

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

Add a secondary label pointing to related code.

Labels appear as additional annotations in the source snippet.

pub fn with_note(self, message: impl Into<String>) -> Self

Add an informational note.

Notes appear as footer messages providing context.

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

Add a help suggestion.

Helps appear as footer messages with actionable advice.

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

Add a code suggestion that can be applied to fix the issue.

Suggestions provide machine-readable fix information for IDEs and tools.

impl DiagnosticWrapper<ErrorKind>

pub fn at(kind: ErrorKind, pos: u32) -> Self

Create an error at a specific position (zero-length span).

Trait Implementations

impl<K: Clone> Clone for DiagnosticWrapper<K>

fn clone(&self) -> DiagnosticWrapper<K>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K: Debug> Debug for DiagnosticWrapper<K>

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

Formats the value using the given formatter.

impl<K: Display> Display for DiagnosticWrapper<K>

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

Formats the value using the given formatter.

impl<K: Display + Debug> Error for DiagnosticWrapper<K>

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.

impl From<DiagnosticWrapper<ErrorKind>> for CompileErrors

fn from(error: CompileError) -> Self

Converts to this type from the input type.