Struct Finding 

pub struct Finding {

    pub category: Category,
    pub path: String,
    pub name: String,
    pub exported_as: Option<String>,
    pub symbol_kind: Option<SymbolKind>,
    pub parent: Option<String>,
    pub language: String,
    pub start: Location,
    pub end: Location,
    pub lines: u32,
    pub confidence: u8,
    pub reasons: Vec<Reason>,
    pub message: String,
}

A single piece of dead code.

Fields

category: Category

Which rule produced this.

path: String

Scan-root-relative path of the file the finding is in.

name: String

Declared name. Empty for Category::UnusedFile.

exported_as: Option<String>

The name other modules would import it by, when it differs from name.

symbol_kind: Option<SymbolKind>

What kind of declaration this is. None for a whole-file finding.

parent: Option<String>

Enclosing class or enum name, for members.

language: String

The analyzer’s language id (js, python, …). A string rather than an enum so that a new language is a new analyzer, not a new variant in this crate.

start: Location

end: Location

lines: u32

Lines the declaration spans — the size of the deletion.

confidence: u8

0-100. See basta::confidence for how it is derived.

reasons: Vec<Reason>

Why the confidence is not 100, most significant first.

message: String

One-line human-readable statement of the finding.

Implementations

impl Finding

pub fn level(&self) -> ConfidenceLevel

Confidence as a coarse bucket, for reporters that cannot show a number.

pub fn fingerprint(&self) -> String

Stable identity of a finding across runs: the same declaration in the same file keeps its fingerprint when unrelated lines move, because the line number is deliberately not part of it.

Trait Implementations

impl Clone for Finding

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Finding

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Finding

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Finding

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.