Struct LintIssueDisplay 

pub struct LintIssueDisplay {
    pub level: Level,
    pub scoped_name: String,
    pub summary: Option<String>,
    pub arrow_line: Option<String>,
    pub message: String,
    pub help_text: String,
    pub custom_links: BTreeMap<String, String>,
}

A generic structure that represents all possible components of a lint issue display.

The actual layouting is done in the fmt::Display implementation of LintIssueDisplay.

Visual Layout

   level[scoped_name]: summary    <- header with optional summary
   --> arrow_line                 <- arrow line with context (optional)
    |
    | message                     <- main issue description
    |
   help: help_text line 1         <- help section
         help_text line 2...
      = custom_link: url          <- custom links (optional)
      = see: documentation_url    <- auto-generated doc link

Examples

warning[source_info::duplicate_architecture]
  -->  in field 'arch' for package 'example'
   |
   | found duplicate value: x86_64
   |
help: Architecture lists should be unique.
   = see: https://alpm.archlinux.page/lints/...

Fields

level: Level

The lint level of the lint rule.

scoped_name: String

The full name of the lint rule.

summary: Option<String>

The optional summary of the lint rule.

arrow_line: Option<String>

The optional information on where the issue occurs.

message: String

A message outlining what the specific issue is.

help_text: String

A help text outlining what can be done to fix the issue.

custom_links: BTreeMap<String, String>

A map of additional URL names and URLs.

Trait Implementations

impl Clone for LintIssueDisplay

fn clone(&self) -> LintIssueDisplay

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LintIssueDisplay

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

Formats the value using the given formatter.

impl Display for LintIssueDisplay

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

Formats the value using the given formatter.

impl From<LintIssue> for LintIssueDisplay

fn from(other: LintIssue) -> LintIssueDisplay

Convert this LintIssue into a LintIssueDisplay for formatted output.