Struct CodeMetrics 

pub struct CodeMetrics {

    pub nargs: Stats,
    pub nexits: Stats,
    pub cognitive: Stats,
    pub cyclomatic: Stats,
    pub halstead: Stats,
    pub loc: Stats,
    pub nom: Stats,
    pub tokens: Stats,
    pub mi: Stats,
    pub abc: Stats,
    pub wmc: Stats,
    pub npm: Stats,
    pub npa: Stats,
    pub selected: MetricSet,
}

All metrics data.

The set of metrics actually computed is governed by MetricsOptions::with_only. By default every metric is populated; when with_only restricts the set, unselected fields remain at their Default value and are elided from Serialize output. The selected mask is the source of truth for which fields are populated — read it via CodeMetrics::selected.

Fields

nargs: Stats

NArgs data

nexits: Stats

NExits data

cognitive: Stats

Cognitive data

cyclomatic: Stats

Cyclomatic data

halstead: Stats

Halstead data

loc: Stats

Loc data

nom: Stats

Nom data

tokens: Stats

Tokens data

mi: Stats

Mi data

abc: Stats

Abc data

wmc: Stats

Wmc data

npm: Stats

Npm data

npa: Stats

Npa data

selected: MetricSet

Which metrics were actually computed for this space.

Default is MetricSet::all — every metric was run, matching the pre-#257 behaviour. After MetricsOptions::with_only the bitfield is restricted to the caller’s selection plus auto-added dependencies.

The Serialize impl consults this set to elide fields the caller did not select. The field itself is not serialized.

Implementations

impl CodeMetrics

pub fn with_selected(selected: MetricSet) -> Self

Construct a CodeMetrics whose selected mask is the given MetricSet. All metric fields are at their Default value; the walker fills them in for whichever metrics the mask admits.

pub fn selected(&self) -> MetricSet

Returns the set of metrics that were computed for this space.

impl CodeMetrics

pub fn merge(&mut self, other: &CodeMetrics)

Sum each metric component from other into self in place. Used to roll nested function-space metrics into their parent space.

Trait Implementations

impl Clone for CodeMetrics

fn clone(&self) -> CodeMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeMetrics

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

Formats the value using the given formatter.

impl Default for CodeMetrics

fn default() -> CodeMetrics

Returns the “default value” for a type.

impl Display for CodeMetrics

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

Formats the value using the given formatter.

impl Serialize for CodeMetrics

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

where S: Serializer,

Serialize this value into the given Serde serializer.