Struct IssueOutputContract 

pub struct IssueOutputContract {
    pub code: &'static str,
    pub result_key: &'static str,
    pub counts_in_total: bool,
    pub summary_label: &'static str,
    pub summary_docs_anchor: &'static str,
    pub meta_name: &'static str,
    pub meta_description: &'static str,
    pub meta_docs_path: &'static str,
    pub sarif_rule_ids: Vec<String>,
    pub codeclimate_check_names: Vec<String>,
    pub ts_alias: Option<TsAliasMeta>,
}

Output-facing contract metadata for a serialized dead-code result row.

Fields

code: &'static str

Canonical issue code that owns this result array.

result_key: &'static str

Serialized AnalysisResults array key that carries this issue row.

counts_in_total: bool

Whether result_key contributes to AnalysisResults::total_issues().

summary_label: &'static str

Label used by CI summary tables.

summary_docs_anchor: &'static str

Documentation anchor used by CI summary tables.

meta_name: &'static str

Human-readable name emitted in dead-code _meta.rules.

meta_description: &'static str

Explanation emitted in dead-code _meta.rules.

meta_docs_path: &'static str

Documentation path emitted in dead-code _meta.rules.

sarif_rule_ids: Vec<String>

SARIF rule ids used by the CLI SARIF formatter for this result row.

codeclimate_check_names: Vec<String>

CodeClimate check names used by the CodeClimate formatter.

ts_alias: Option<TsAliasMeta>

Published TypeScript alias policy for backwards-compatible bare names.

Trait Implementations

impl Clone for IssueOutputContract

fn clone(&self) -> IssueOutputContract

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IssueOutputContract

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

Formats the value using the given formatter.

impl Eq for IssueOutputContract

impl PartialEq for IssueOutputContract

fn eq(&self, other: &IssueOutputContract) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for IssueOutputContract