Skip to main content

HealthSummary

Struct HealthSummary 

Source
pub struct HealthSummary {
Show 20 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_input_format: Option<CoverageInputFormat>, 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<BaselineStaleness>,
}
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_input_format: Option<CoverageInputFormat>

Input format of the measured coverage (istanbul or v8). Present only with coverage_model: "istanbul".

§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<BaselineStaleness>

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

Trait Implementations§

Source§

impl Clone for HealthSummary

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HealthSummary

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HealthSummary

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for HealthSummary

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for HealthSummary

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

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

Converts to this type from the input type within the given allocator.
Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

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

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

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

Converts this type into the (usually inferred) input type within the given allocator.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more