Struct DensityItem 

pub struct DensityItem {
    pub path: String,
    pub markers: u32,
    pub lines: u32,
    pub per_kloc: f64,
    pub by_category: BTreeMap<String, usize>,
}

One file’s intent-debt density in a DebtDensityReport.

Fields

path: String

Repository-relative path of the file.

markers: u32

Retained markers in this file (after category and ignore filtering).

lines: u32

The file’s length in lines — the denominator. See debt_density for exactly what this counts and what it does not.

per_kloc: f64

Markers per 1,000 lines, rounded to two decimals. Per kilo-line rather than per line because per-line densities are all leading zeroes: this repository’s worst file is 0.06 markers per line, and 60.0 per kloc is a number a reader can hold.

by_category: BTreeMap<String, usize>

Count per category within this file, ordered by category token — so a dense file can be read as “twelve todo” or “twelve stub”, which are not the same finding.

Trait Implementations

impl Clone for DensityItem

fn clone(&self) -> DensityItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DensityItem

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

Formats the value using the given formatter.

impl PartialEq for DensityItem

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DensityItem

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DensityItem