Struct TidyNotification

pub struct TidyNotification {
    pub filename: String,
    pub line: u32,
    pub cols: u32,
    pub severity: String,
    pub rationale: String,
    pub diagnostic: String,
    pub suggestion: Vec<String>,
    pub fixed_lines: Vec<u32>,
}

A structure that represents a single notification parsed from clang-tidy’s stdout.

Fields

filename: String

The file’s path and name (supposedly relative to the repository root folder).

line: u32

The line number from which the notification originated.

cols: u32

The column offset on the line from which the notification originated.

severity: String

The severity (ie error/warning/note) of the TidyNotification::diagnostic that caused the notification.

rationale: String

A helpful message explaining why the notification exists.

diagnostic: String

The diagnostic name as used when configuring clang-tidy.

suggestion: Vec<String>

A code block that points directly to the origin of the notification.

Sometimes, this code block doesn’t exist. Sometimes, it contains suggested fixes/advice. This information is purely superfluous.

fixed_lines: Vec<u32>

The list of line numbers that had fixes applied via clang-tidy --fix-error.

Implementations

impl TidyNotification

pub fn diagnostic_link(&self) -> String

Trait Implementations

impl Clone for TidyNotification

fn clone(&self) -> TidyNotification

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TidyNotification

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

Formats the value using the given formatter.