Struct HealthSummary

Source

pub struct HealthSummary {Show 19 fields
    pub files_analyzed: usize,
    pub functions_analyzed: usize,
    pub functions_above_threshold: usize,
    pub max_cyclomatic_threshold: u16,
    pub max_cognitive_threshold: u16,
    pub max_crap_threshold: f64,
    pub max_unit_size_threshold: u32,
    pub files_scored: Option<usize>,
    pub average_maintainability: Option<f64>,
    pub coverage_model: Option<CoverageModel>,
    pub coverage_source_consistency: Option<CoverageSourceConsistency>,
    pub istanbul_matched: Option<usize>,
    pub istanbul_total: Option<usize>,
    pub istanbul_files_matched: Option<usize>,
    pub istanbul_files_total: Option<usize>,
    pub severity_critical_count: usize,
    pub severity_high_count: usize,
    pub severity_moderate_count: usize,
    pub baseline_staleness: Option<HealthBaselineStaleness>,
}

Expand description

Summary statistics for the health report.

Fields§

§files_analyzed: usize

Files included in the health analysis.

§functions_analyzed: usize

Functions and template units checked for threshold findings across the analyzed files. Synthetic module-scope units are excluded. Cyclomatic aggregates include module units too; vital_signs.cyclomatic_population reports the disjoint authored-function, module, and template populations behind those aggregates.

§functions_above_threshold: usize

Functions exceeding at least one complexity or CRAP threshold.

§max_cyclomatic_threshold: u16

Global cyclomatic-complexity ceiling for this run.

§max_cognitive_threshold: u16

Global cognitive-complexity ceiling for this run.

§max_crap_threshold: f64

Global CRAP-score ceiling for this run.

§max_unit_size_threshold: u32

Effective global unit-size ceiling (health.maxUnitSize, maximum function length in lines) for this run. Sits alongside the other three max_*_threshold siblings so a consumer reading the summary sees every configured threshold. Per-file thresholdOverrides are not reflected here; this is the global default.

§files_scored: Option<usize>

Files with a computed maintainability score; absent when file scoring did not run.

§average_maintainability: Option<f64>

Mean maintainability index over scored files (0-100).

§coverage_model: Option<CoverageModel>

Coverage model behind the CRAP scores, when coverage was used.

§coverage_source_consistency: Option<CoverageSourceConsistency>

Whether CRAP findings mix coverage sources.

§istanbul_matched: Option<usize>

Functions matched against the Istanbul coverage file, in Istanbul mode.

§istanbul_total: Option<usize>

Functions in the Istanbul coverage file, in Istanbul mode.

§istanbul_files_matched: Option<usize>

Analyzed files the Istanbul coverage file carried an entry for. Read against istanbul_files_total, this separates a coverage file that did not join from code the coverage file says nothing ran in.

§istanbul_files_total: Option<usize>

Files described by the Istanbul coverage file, joined or not.

§severity_critical_count: usize

Findings with critical severity.

§severity_high_count: usize

Findings with high severity.

§severity_moderate_count: usize

Findings with moderate severity.

§baseline_staleness: Option<HealthBaselineStaleness>

Baseline staleness data, present only when a baseline was loaded.

HealthSummary

Struct HealthSummary Copy item path

Fields§

Trait Implementations§

impl Clone for HealthSummary

fn clone(&self) -> HealthSummary

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

impl Debug for HealthSummary

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

impl Default for HealthSummary

fn default() -> Self

impl Serialize for HealthSummary

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

Auto Trait Implementations§

impl Freeze for HealthSummary

impl RefUnwindSafe for HealthSummary

impl Send for HealthSummary

impl Sync for HealthSummary

impl Unpin for HealthSummary

impl UnsafeUnpin for HealthSummary

impl UnwindSafe for HealthSummary

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> DynClone for Twhere T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

impl<'a, T> FromIn<'a, T> for T

fn from_in(t: T, _: &'a Allocator) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

fn in_current_span(self) -> Instrumented<Self> ⓘ

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<'a, T, U> IntoIn<'a, U> for Twhere U: FromIn<'a, T>,

fn into_in(self, allocator: &'a Allocator) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black(&self) -> FgColorDisplay<'_, Black, Self>

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

fn red(&self) -> FgColorDisplay<'_, Red, Self>

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

fn green(&self) -> FgColorDisplay<'_, Green, Self>

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

fn white(&self) -> FgColorDisplay<'_, White, Self>

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Struct HealthSummary

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T> DynClone for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

impl<'a, T, U> IntoIn<'a, U> for T
where U: FromIn<'a, T>,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,