Skip to main content

Diagnostic

Struct Diagnostic 

Source
pub struct Diagnostic {
    pub severity: Severity,
    pub message: String,
    pub file: Option<String>,
    pub line: Option<u32>,
    pub column: Option<u32>,
    pub category: Option<String>,
    pub fix_its: Vec<String>,
    pub snippet: Option<String>,
    pub note: Option<String>,
    pub help: Option<String>,
}
Expand description

A structured diagnostic extracted from the C parser (clang-sys).

Contains source location, code snippet, categorized explanation, and actionable fix suggestion, formatted in rustc-style output.

Fields§

§severity: Severity

Severity: Note, Warning, Error, Fatal

§message: String

Error message from clang (e.g. “expected ‘)’”)

§file: Option<String>

Source file path

§line: Option<u32>

1-based line number

§column: Option<u32>

1-based column number

§category: Option<String>

Clang diagnostic category (e.g. “Parse Issue”)

§fix_its: Vec<String>

Suggested fixes from clang fix-its

§snippet: Option<String>

3-line code snippet with caret indicator

§note: Option<String>

Explanatory note (WHY it failed)

§help: Option<String>

Actionable help (HOW to fix)

Implementations§

Source§

impl Diagnostic

Source

pub fn new(severity: Severity, message: impl Into<String>) -> Self

Create a new diagnostic with the given severity and message.

Source

pub fn error_category(&self) -> ErrorCategory

Infer the error category from the clang category or message content.

Source

pub fn build_snippet( source: &str, line: u32, column: Option<u32>, ) -> Option<String>

Build a 3-line code snippet with a caret pointing at the error column.

Source

pub fn infer_note_and_help(&mut self)

Populate note and help based on common C error patterns.

Trait Implementations§

Source§

impl Clone for Diagnostic

Source§

fn clone(&self) -> Diagnostic

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Diagnostic

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Diagnostic

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.