Struct ComplexityListing 

pub struct ComplexityListing {
    pub listed: usize,
    pub above: usize,
    pub complexity_section: Option<bool>,
    pub score_only: bool,
    pub baselined: bool,
    pub remaining: Option<usize>,
}

What a health report says about its complexity findings. Markdown and the job summary build it from the report and use one rule, so the two surfaces agree.

Fields

listed: usize

The length of the finding list.

above: usize

summary.functions_above_threshold, which fallow counts before the baseline.

complexity_section: Option<bool>

Some(true) when sections contains complexity, Some(false) when sections does not, and None for an older report without sections.

score_only: bool

True when the report has no vital_signs, which only a score-only run omits. The rule reads it only when complexity_section is None.

baselined: bool

True when the run loaded a baseline.

remaining: Option<usize>

summary.baseline_staleness.remaining_findings: the functions above a threshold that the baseline does not accept. None without a baseline and in an older report.

Implementations

impl ComplexityListing

pub const fn count_unlisted(&self) -> bool

Tell if the complexity section gives the count of functions above a threshold instead of a clean result.

A run that did not produce the complexity section does not list findings, so an empty list does not make it clean. A run that lists findings, with an empty list and a baseline, is clean: the baseline accepts every finding.

An older report without sections falls back to the earlier rule: a score-only run gives the count, and another run gives the count only without a baseline.

pub fn not_listed_note(&self) -> String

The sentences after the count of functions that the run does not list.

With a baseline, the note tells how many functions the baseline accepts and how many are new. An older report without remaining_findings says that the count includes the accepted functions.

Trait Implementations

impl Clone for ComplexityListing

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ComplexityListing

impl Debug for ComplexityListing

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

Formats the value using the given formatter.

impl Eq for ComplexityListing

impl PartialEq for ComplexityListing

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ComplexityListing